ProOne External APIs documents (α version)

Download OpenAPI specification:

はじめに

本APIはプロワンのサービス提供者向けの公開APIとなります。

現在はαバージョンのため、APIの内容は変更になる可能性があります。

対応しているリソースは左メニューの通りです。

利用開始までの流れ

Step 1. API利用規約を確認する

APIの利用を開始する前に、API利用規約をご確認ください。

Step 2. プロワンにログインする

Step 3. API Key を申請する

現在準備中です。新規発行および key の再発行については、お問い合わせください。

Step 4. API の動作確認をする

発行された API Key を利用して、APIをリクエストします。

API 共通情報

API エンドポイント

https://api-external.meetsone.com/api/external

利用規約

本APIを利用された場合、弊社の「API利用規約」のすべての内容に同意したものとみなされます。ご利用前に必ずご確認ください。

認証

本APIでは X-Api-Key ヘッダーに API キーを付与して認証を行います。認証に必要なAPIキーはお問い合わせ頂く必要があります。

クライアントは、APIリクエストを行うときに、Headerで以下の形式でAPIキーを付与して送信する必要があります。

X-Api-Key: <api-key>

漏洩リスク

APIキーは漏洩リスクが高いため、安全に保管するようにしてください。 Github, Bitbucket などのサードパーティーのホスティングサービスや、フロントエンドのコード内など、外部に公開される場所には絶対に置かないようにしてください。

バージョニング

本APIでは X-Api-Version ヘッダーを使用して、API のバージョンを指定する必要があります。

X-Api-Version: 2024-07-01

X-Api-Version ヘッダーのないリクエストは、最新のバージョンが使用されます。

サポートされる API バージョン

現在は次の API バージョンがサポートされています。

2024-07-01 (latest)
2024-04-01

利用制限

本APIには、安定したサービス提供のため、以下の利用制限があります。これらの制限は外部APIにのみ適用されます。

項目	制限
リクエスト回数	APIキーごとに `100,000 リクエスト/日`
リクエストレート	APIキーごとに `100 リクエスト/秒`
バースト	APIキーごとに `100 リクエスト`
タイムアウト	`29秒`
リクエストサイズ	`10 MB` 以下
利用可能時間帯	24時間利用可能。ただし、メンテナンス、障害、その他当社が必要と判断した場合を除きます。
データ形式	各APIの仕様に定める `JSON` 形式に従うものとします。

上記の利用制限を超過した場合、または本サービスの安定した運用に影響を及ぼすおそれがあると当社が判断した場合、リクエストの制限またはAPIの利用停止を行うことがあります。

短時間に多数のリクエストが行われた場合など、429 Too Many Requests 等のエラーが返却されることがあります。 429 Too Many Requests を受け取った場合は、一定時間を空けてからリトライしてください。

エラー

レスポンスコード

本 API は一般的な HTTP レスポンスコードを利用しています。

2xx の範囲の、ステータスコードは正常処理を表します。 4xx の範囲は、リクエストの Parameter などの入力に起因するエラーで、リクエストが受付られない状態を表します。 5xx の範囲は、サーバ内部で正常に処理が行われなかった状態を表します。

ステータスコード	説明
400 - Bad Request	Parameter の不備などでリクエストを受け付けられない。
401 - Unauthorized	認証ができない。`api-key` が不正である。
403 - Forbidden	対象の API 実行が認可されていない。
404 - Not Found	指定したリソースが存在しない。
429 - Too Many Requests	レートリミットを超えてリクエストされた。
500, 502, 503, 504 - Server Errros	サーバ内で処理が正常に行われなかった。

レスポンスボディ

エラー発生時には、下記のようなエラーを返します。

Error

項目名	型	説明
statusCode	string	エラーコード文字列
message	string	エラーメッセージ

ページネーション

ページネーションパラメータ

本APIでは、pageパラメータ(1始まり)を指定することでページネーションすることができます。また、perPageで1ページ当たりの件数を指定することができます。

ページネーションレスポンス

ページネーションのあるAPIエンドポイントでは以下の形式でデータが返却されます。

項目名	型	説明
data	array	目的の Object のリスト。array 形式になっています。
total	number	目的の Object の総数

変更履歴

2024-03-05

一覧APIのメソッドをGETからPOSTへ変更しました

複雑な検索条件に対応するためにメソッドを変更し、リクエストボディに検索条件を含めるようにしました。それに伴いエンドポイントも変更しました。変更があるAPIは以下の通りです。

-	変更前	変更後
1	`GET /api/jobs`	`POST /api/jobs/list`
2	`GET /api/estiamtes`	`POST /api/estimates/list`
3	`GET /api/addresses`	`POST /api/addresses/list`
4	`GET /api/clients`	`POST /api/clients/list`

API のドメインを変更しました

API のドメインを変更しました。新しいドメインは api-external.meetsone.com です。

※古いドメイン api.meetsone.com は引き続き利用可能ですが、将来的に廃止される予定です。

認証方法を変更しました

Authorization ヘッダーでの Bearer 認証を廃止し、X-Api-Key ヘッダーでの認証に変更しました。

（しばらくの間は両方の認証方法を受け付けますが、X-Api-Key への移行をお願いします）

仕事

仕事詳細を取得

仕事詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clhhayfgu0003015kcsx0hvid

仕事ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

仕事詳細情報

id

required

string

仕事ID

externalId

string or null

外部ID

slug

required

string

管理番号

title

required

string

仕事名

cancelledAt

string or null <date-time>

仕事失注日

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

createdAt

required

string <date-time>

仕事作成日

finishedAt

string or null <date-time>

仕事終了日

expectedOrderAmount

string or nulld+(.d+)?

受注予定金額

expectedOrderDate

string or null <date-time>

受注予定日

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

受注状況

依頼受領 request
見積作成中 before estimating
見積発行済み estimating
完了 ordered
失注 cancelled

jobStatus

required

string

Enum: "completed" "no appointment" "appointment completed" "progress"

仕事状況

日程未定 no appointment
進行中 progress
日程完了 appointment completed
完了 completed

invoiceStatus

required

string

Enum: "cancelled" "partiallyPaid" "paid" "requested" "issued" "waiting"

請求状況

請求前 waiting
請求中 issued
入金済み paid

purchaseOrderStatus

required

string

Enum: "issued" "delivered" "waiting" "ordering"

発注状況

発行済み issued
発注中 ordering
納品済み delivered
未発行 waiting

purchaseOrderPaymentStatus

required

string

Enum: "notReceived" "received" "partiallyPaid" "paid" "waiting"

発注支払状況

請求受領 received
一部支払 partiallyPaid
支払済み paid
請求未受領 waiting

documentStatus

required

string

Enum: "issued" "waiting"

書類状況

発行済み issued
発行前 waiting

isAssignedToMe

required

boolean

仕事担当者または訪問担当者に対象のユーザーIDが含まれているかどうかを示すフラグ

updatedAt

required

string <date-time>

仕事の最終更新日

dataUpdatedAt

required

string <date-time>

仕事に関連する情報の最終更新日 = 最新ログの作成日

required

object

顧客情報

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

useClientAddressForBilling

required

boolean

顧客の住所を請求先住所として使用するかどうかのフラグ

object or null

請求先情報

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

required

object

顧客情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

clientId

required

string

顧客ID

required

Array of objects (ExternalEstimateSimple)

見積書情報の配列

Array

id required	string 見積書ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 見積書タイトル
slug required	string 見積書番号
effectiveDuration required	string 有効期限
issuedAt	string or null <date-time> 見積書発行日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
isArchive required	boolean アーカイブフラグ
orderStatus required	string Enum: "cancelled" "ordered" "estimating" "before estimating" "request" 発行状態作成前 request 作成中 before estimating 発行済み estimating 受注 ordered 失注 cancelled
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

required

Array of objects (ExternalInvoiceSimple)

請求書情報の配列

Array

id required	string 請求書ID
externalId	string or null 外部ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 請求書タイトル
slug required	string 管理番号
dueAt	string or null <date-time> 支払い期限日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
issuedAt	string or null <date-time> 請求書発行日
billedAt	string or null <date-time> 請求日
requestedAt	string or null <date-time> ステータスが請求中に更新された日時
paidAt	string or null <date-time> 入金日
partiallyPaidAt	string or null <date-time> 一部入金日
isArchive required	boolean アーカイブ済みかどうか
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved" 承認ステータス
estimateId	string or null 紐づいている見積書ID

required

Array of objects (ExternalExpectedCostSimple)

実行予算情報の配列

Array

id required	string 実行予算ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 実行予算タイトル
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
slug required	string 管理番号
note	string or null 備考
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
issuedAt	string or null <date-time> 発行日
deletedAt	string or null <date-time> 削除日

required

Array of objects (AppointmentForExternalJob)

仕事日程情報の配列

Array

id

required

string

仕事日程ID

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

required

Array of objects (JobTagForExternalJob)

仕事タグ情報の配列

Array

id required	string 仕事タグID
name required	string 仕事タグ名
shortcode	string or null 短縮形
color required	string 仕事タグの色
isArchive required	boolean アーカイブフラグ trueの場合アーカイブ済み

object or null

仕事タイプ情報

id required	string 仕事タイプID
name required	string 仕事タイプ名
durationMinutes required	number 所要時間
memo	string or null メモ
isActive required	boolean 有効フラグ trueの場合有効
color required	string 仕事タイプの色カラーコードを指定する

required

object

現場情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

required

Array of objects (DivisionForExternalJob)

部署一覧情報の配列

Array

id required	string 部署ID
name required	string 部署名

object or null

集客元情報

id required	string 集客元ID
name required	string 集客元名

required

Array of objects (UserForExternalJob)

仕事担当者情報の配列

Array

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

object or null

収支情報

required

object

収支サマリー

expense required	number 経費
netSales required	number 最終利益
totalProfitRatio required	number 最終利益率
costPrice required	number 原価
sales required	number 売上
grossProfit required	number 粗利
profitRatio required	number 粗利率

memo

string or null

メモ

object or null

支払い方法

id required	string 支払い方法ID
name required	string 支払い方法名

object or null

フェーズ情報

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

object or null

パイプライン情報

id

required

string

パイプラインID

name

required

string

パイプライン名

required

Array of objects (PhaseForExternalJob)

フェーズ情報の配列

Array

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

failureReason

string or null

備考

Array of objects (OrderFailureReasonForExternalJob)

失注理由

Array

apiName	string or null API参照名
reason	string or null 失注理由

Response samples

Content type

application/json

{"data": {"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"slug": "2024-02-003",
"title": "TESTInc.様/エアコンクリーニング",
"cancelledAt": "2021-06-01T00:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"createdAt": "2021-06-01T00:00:00.000Z",
"finishedAt": "2021-06-07T00:00:00.000Z",
"expectedOrderAmount": "200000",
"expectedOrderDate": "2023-05-05T00:00:00.000Z",
"orderStatus": "ordered",
"jobStatus": "progress",
"invoiceStatus": "paid",
"purchaseOrderStatus": "issued",
"purchaseOrderPaymentStatus": "received",
"documentStatus": "issued",
"isAssignedToMe": true,
"updatedAt": "2023-06-09T00:00:00.000Z",
"dataUpdatedAt": "2023-06-09T00:00:00.000Z",
"contact": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"useClientAddressForBilling": true,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
},
"client": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30"
},
"clientId": "clq5z3bi8008s5p011j24pj6i"
},
"estimates": [{"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress"
}
],
"invoices": [{"id": "clei758p6001u5l01w5ztspw6",
"externalId": "string",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-I01",
"dueAt": "2023-06-30T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"billedAt": "2023-06-01T02:00:00.000Z",
"requestedAt": "2023-06-01T02:00:00.000Z",
"paidAt": "2023-06-05T02:00:00.000Z",
"partiallyPaidAt": "2023-06-05T02:00:00.000Z",
"isArchive": false,
"approvalStatus": "InProgress",
"estimateId": "clptk0yf302315o01wq9zbo6g"
}
],
"expectedCosts": [{"id": "clc5yxs9y000f5mr60iqw61qu",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "備品費",
"taxType": "TaxIncluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"slug": "2023-06-01-I01",
"note": "特になし",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"deletedAt": "2023-06-01T02:00:00.000Z"
}
],
"appointments": [{"id": "cl5c0bcz318351015l39r39wao",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
],
"jobTags": [{"id": "clq5z3bi8008q5p0187stneu4",
"name": "2022-01-03T02:00:00.000Z",
"shortcode": "H",
"color": "#E9967A",
"isArchive": false
}
],
"jobType": {"id": "clexrnhoc00044j01qxgt84c6",
"name": "エアコンクリーニング",
"durationMinutes": 60,
"memo": "壁掛けタイプのエアコンのみ対応",
"isActive": true,
"color": "#FF0999"
},
"address": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
]
},
"divisions": [{"id": "cl5ais9zo8089015sbda9dhmq",
"name": "第一営業部"
}
],
"leadSource": {"id": "cl5c0gaoe19534015l29i76dzl",
"name": "広告会社A"
},
"personInChargeUsers": [{"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
],
"balance": {"summary": {"expense": 100000,
"netSales": 250000,
"totalProfitRatio": 1.24,
"costPrice": 150000,
"sales": 400000,
"grossProfit": 50000,
"profitRatio": 0.125
}
},
"memo": "特になし",
"paymentMethod": {"id": "clhe6u5gb00m14d0125nx2cjz",
"name": "クレジットカード"
},
"phase": {"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
},
"pipeline": {"id": "clkm13i0x00945w01t57rk37i",
"name": "パイプラインB",
"phases": [{"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
}
]
},
"failureReason": "string",
"orderFailureReasons": [{"apiName": "string",
"reason": "string"
}
]
}
}

仕事一覧を取得

テナントの仕事一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

phaseId

string or null

フェーズID

pipelineId

string or null

パイプラインID

clientId

string or null

顧客ID

addressId

string or null

現場ID

equipmentId

string or null

機器ID

userIds

Array of strings

訪問担当者のユーザーID

personInChargeUserIds

Array of strings

仕事担当者のユーザーID

divisionIds

Array of strings

担当部署ID

jobIds

Array of strings

仕事ID

jobTypeIds

Array of strings

仕事タイプID

jobTagIds

Array of strings

仕事タグID

jobTitle

string or null

仕事名

orderStatuses

Array of strings or null

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

受注状況

依頼受領 request
見積作成中 before estimating
見積発行済み estimating
完了 ordered
失注 cancelled

jobStatuses

Array of strings or null

Enum: "completed" "no appointment" "appointment completed" "progress"

仕事状況

日程未定 no appointment
進行中 progress
日程完了 appointment completed
完了 completed

invoiceStatuses

Array of strings or null

Enum: "cancelled" "partiallyPaid" "paid" "requested" "issued" "waiting"

請求状況

請求前 waiting
請求中 issued
入金済み paid

jobLeadSourceIds

Array of strings

仕事の集客元ID

clientLeadSourceIds

Array of strings

顧客の集客元ID

object

更新日の範囲

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

更新日の範囲

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

object

更新日の範囲

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

object

仕事日の範囲

start	string or null <date-time> 仕事日の範囲開始日時
end	string or null <date-time> 仕事日の範囲終了日時

object

見積書発行日の範囲

start	string or null <date-time> 見積書発行日の範囲開始日時
end	string or null <date-time> 見積書発行日の範囲終了日時

object

請求書発行日の範囲

start	string or null <date-time> 請求書発行日の範囲開始日時
end	string or null <date-time> 請求書発行日の範囲終了日時

object

発注書発行日の範囲

start	string or null <date-time> 発注書発行日の範囲開始日時
end	string or null <date-time> 発注書発行日の範囲終了日時

query

string or null

自由文字列の検索ワード

hasExpectedCosts

boolean or null

実行予算を持っているフラグ持つ場合はtrue

isProgressInvoiceEstimate

boolean or null

出来高請求書を持っているフラグ持つ場合はtrue

Array of objects (ExternalSearchConditionFilterForPhase)

フェーズ情報の配列

Array

start	string or null <date-time> フェーズの範囲開始日時
end	string or null <date-time> フェーズの範囲終了日時
phaseId	string or null フェーズID
pipelineId	string or null パイプラインID

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalJob)

仕事情報の配列

Array

id

required

string

仕事ID

externalId

string or null

外部ID

slug

required

string

管理番号

title

required

string

仕事名

cancelledAt

string or null <date-time>

仕事失注日

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

createdAt

required

string <date-time>

仕事作成日

finishedAt

string or null <date-time>

仕事終了日

expectedOrderAmount

string or nulld+(.d+)?

受注予定金額

expectedOrderDate

string or null <date-time>

受注予定日

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

受注状況

依頼受領 request
見積作成中 before estimating
見積発行済み estimating
完了 ordered
失注 cancelled

jobStatus

required

string

Enum: "completed" "no appointment" "appointment completed" "progress"

仕事状況

日程未定 no appointment
進行中 progress
日程完了 appointment completed
完了 completed

invoiceStatus

required

string

Enum: "cancelled" "partiallyPaid" "paid" "requested" "issued" "waiting"

請求状況

請求前 waiting
請求中 issued
入金済み paid

purchaseOrderStatus

required

string

Enum: "issued" "delivered" "waiting" "ordering"

発注状況

発行済み issued
発注中 ordering
納品済み delivered
未発行 waiting

purchaseOrderPaymentStatus

required

string

Enum: "notReceived" "received" "partiallyPaid" "paid" "waiting"

発注支払状況

請求受領 received
一部支払 partiallyPaid
支払済み paid
請求未受領 waiting

documentStatus

required

string

Enum: "issued" "waiting"

書類状況

発行済み issued
発行前 waiting

isAssignedToMe

required

boolean

仕事担当者または訪問担当者に対象のユーザーIDが含まれているかどうかを示すフラグ

updatedAt

required

string <date-time>

仕事の最終更新日

dataUpdatedAt

required

string <date-time>

仕事に関連する情報の最終更新日 = 最新ログの作成日

required

object

顧客情報

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

useClientAddressForBilling

required

boolean

顧客の住所を請求先住所として使用するかどうかのフラグ

object or null

請求先情報

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

required

object

顧客情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

clientId

required

string

顧客ID

required

Array of objects (ExternalEstimateSimple)

見積書情報の配列

Array

id required	string 見積書ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 見積書タイトル
slug required	string 見積書番号
effectiveDuration required	string 有効期限
issuedAt	string or null <date-time> 見積書発行日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
isArchive required	boolean アーカイブフラグ
orderStatus required	string Enum: "cancelled" "ordered" "estimating" "before estimating" "request" 発行状態作成前 request 作成中 before estimating 発行済み estimating 受注 ordered 失注 cancelled
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

required

Array of objects (ExternalInvoiceSimple)

請求書情報の配列

Array

id required	string 請求書ID
externalId	string or null 外部ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 請求書タイトル
slug required	string 管理番号
dueAt	string or null <date-time> 支払い期限日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
issuedAt	string or null <date-time> 請求書発行日
billedAt	string or null <date-time> 請求日
requestedAt	string or null <date-time> ステータスが請求中に更新された日時
paidAt	string or null <date-time> 入金日
partiallyPaidAt	string or null <date-time> 一部入金日
isArchive required	boolean アーカイブ済みかどうか
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved" 承認ステータス
estimateId	string or null 紐づいている見積書ID

required

Array of objects (ExternalExpectedCostSimple)

実行予算情報の配列

Array

id required	string 実行予算ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 実行予算タイトル
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
slug required	string 管理番号
note	string or null 備考
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
issuedAt	string or null <date-time> 発行日
deletedAt	string or null <date-time> 削除日

required

Array of objects (AppointmentForExternalJob)

仕事日程情報の配列

Array

id

required

string

仕事日程ID

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

required

Array of objects (JobTagForExternalJob)

仕事タグ情報の配列

Array

id required	string 仕事タグID
name required	string 仕事タグ名
shortcode	string or null 短縮形
color required	string 仕事タグの色
isArchive required	boolean アーカイブフラグ trueの場合アーカイブ済み

object or null

仕事タイプ情報

id required	string 仕事タイプID
name required	string 仕事タイプ名
durationMinutes required	number 所要時間
memo	string or null メモ
isActive required	boolean 有効フラグ trueの場合有効
color required	string 仕事タイプの色カラーコードを指定する

required

object

現場情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

required

Array of objects (DivisionForExternalJob)

部署一覧情報の配列

Array

id required	string 部署ID
name required	string 部署名

object or null

集客元情報

id required	string 集客元ID
name required	string 集客元名

required

Array of objects (UserForExternalJob)

仕事担当者情報の配列

Array

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

object or null

収支情報

required

object

収支サマリー

expense required	number 経費
netSales required	number 最終利益
totalProfitRatio required	number 最終利益率
costPrice required	number 原価
sales required	number 売上
grossProfit required	number 粗利
profitRatio required	number 粗利率

memo

string or null

メモ

object or null

支払い方法

id required	string 支払い方法ID
name required	string 支払い方法名

object or null

フェーズ情報

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

object or null

パイプライン情報

id

required

string

パイプラインID

name

required

string

パイプライン名

required

Array of objects (PhaseForExternalJob)

フェーズ情報の配列

Array

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

failureReason

string or null

備考

Array of objects (OrderFailureReasonForExternalJob)

失注理由

Array

apiName	string or null API参照名
reason	string or null 失注理由

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"phaseId": "string",
"pipelineId": "string",
"clientId": "string",
"addressId": "string",
"equipmentId": "string",
"userIds": ["string"
],
"personInChargeUserIds": ["string"
],
"divisionIds": ["string"
],
"jobIds": ["string"
],
"jobTypeIds": ["string"
],
"jobTagIds": ["string"
],
"jobTitle": "エアコンクリーニング",
"orderStatuses": ["request",
"before estimating",
"estimating",
"ordered",
"cancelled"
],
"jobStatuses": ["no appointment",
"progress",
"appointment completed",
"completed"
],
"invoiceStatuses": ["waiting",
"issued",
"paid"
],
"jobLeadSourceIds": ["string"
],
"clientLeadSourceIds": ["string"
],
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"updatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"dataUpdatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"jobDate": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"estimateIssuedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"invoiceIssuedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"purchaseOrderIssuedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"query": "エアコンクリーニング",
"hasExpectedCosts": true,
"isProgressInvoiceEstimate": true,
"phases": [{"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z",
"phaseId": "string",
"pipelineId": "string"
}
]
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"slug": "2024-02-003",
"title": "TESTInc.様/エアコンクリーニング",
"cancelledAt": "2021-06-01T00:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"createdAt": "2021-06-01T00:00:00.000Z",
"finishedAt": "2021-06-07T00:00:00.000Z",
"expectedOrderAmount": "200000",
"expectedOrderDate": "2023-05-05T00:00:00.000Z",
"orderStatus": "ordered",
"jobStatus": "progress",
"invoiceStatus": "paid",
"purchaseOrderStatus": "issued",
"purchaseOrderPaymentStatus": "received",
"documentStatus": "issued",
"isAssignedToMe": true,
"updatedAt": "2023-06-09T00:00:00.000Z",
"dataUpdatedAt": "2023-06-09T00:00:00.000Z",
"contact": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"useClientAddressForBilling": true,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
},
"client": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30"
},
"clientId": "clq5z3bi8008s5p011j24pj6i"
},
"estimates": [{"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress"
}
],
"invoices": [{"id": "clei758p6001u5l01w5ztspw6",
"externalId": "string",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-I01",
"dueAt": "2023-06-30T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"billedAt": "2023-06-01T02:00:00.000Z",
"requestedAt": "2023-06-01T02:00:00.000Z",
"paidAt": "2023-06-05T02:00:00.000Z",
"partiallyPaidAt": "2023-06-05T02:00:00.000Z",
"isArchive": false,
"approvalStatus": "InProgress",
"estimateId": "clptk0yf302315o01wq9zbo6g"
}
],
"expectedCosts": [{"id": "clc5yxs9y000f5mr60iqw61qu",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "備品費",
"taxType": "TaxIncluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"slug": "2023-06-01-I01",
"note": "特になし",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"deletedAt": "2023-06-01T02:00:00.000Z"
}
],
"appointments": [{"id": "cl5c0bcz318351015l39r39wao",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
],
"jobTags": [{"id": "clq5z3bi8008q5p0187stneu4",
"name": "2022-01-03T02:00:00.000Z",
"shortcode": "H",
"color": "#E9967A",
"isArchive": false
}
],
"jobType": {"id": "clexrnhoc00044j01qxgt84c6",
"name": "エアコンクリーニング",
"durationMinutes": 60,
"memo": "壁掛けタイプのエアコンのみ対応",
"isActive": true,
"color": "#FF0999"
},
"address": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
]
},
"divisions": [{"id": "cl5ais9zo8089015sbda9dhmq",
"name": "第一営業部"
}
],
"leadSource": {"id": "cl5c0gaoe19534015l29i76dzl",
"name": "広告会社A"
},
"personInChargeUsers": [{"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
],
"balance": {"summary": {"expense": 100000,
"netSales": 250000,
"totalProfitRatio": 1.24,
"costPrice": 150000,
"sales": 400000,
"grossProfit": 50000,
"profitRatio": 0.125
}
},
"memo": "特になし",
"paymentMethod": {"id": "clhe6u5gb00m14d0125nx2cjz",
"name": "クレジットカード"
},
"phase": {"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
},
"pipeline": {"id": "clkm13i0x00945w01t57rk37i",
"name": "パイプラインB",
"phases": [{"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
}
]
},
"failureReason": "string",
"orderFailureReasons": [{"apiName": "string",
"reason": "string"
}
]
}
]
}

仕事を作成または更新

仕事を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id

string or null

仕事ID

externalId

string or null

外部ID

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

現場情報

externalId	string or null 外部ID
id	string or null 現場ID

object

顧客情報

externalId	string or null 外部ID
id	string or null 客先担当者ID

object

顧客情報

externalId	string or null 外部ID
id	string or null 顧客ID

title

string or null

仕事名

titleFormat

string or null

仕事タイトルのテンプレート文字列

memo

string or null <= 10000 characters

メモ

memoMode

string (MemoMode)

Enum: "append" "overwrite"

メモモード overwrite: 既存メモを上書き（追記せず新しいメモで置換）指定なし（デフォルト）: append（従来通り追記） @default append

Array of objects (JobTagsForExternalUpsertJob)

仕事タグ情報の配列

Array

externalId	string or null 外部ID
id	string or null 仕事タグID

object

仕事タイプ情報

externalId	string or null 外部ID
id	string or null 仕事タイプID

object or null

支払い方法

externalId	string or null 外部ID
id	string or null 支払い方法ID

Array of objects (AppointmentForExternalUpsertJob)

仕事日程情報の配列

Array

id

string or null

仕事日程ID

externalId

string or null

外部ID

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

acceptedAt

string or null <date-time>

検収日

object or null

到着時間帯情報

externalId	string or null 外部ID
id	string or null 到着時間帯ID

Array of objects (AssignmentForExternalUpsertJob)

訪問担当者情報

Array

externalId	string or null 外部ID
id	string or null 訪問担当者ID

title

string or null

仕事日程タイトル

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (DivisionForExternalUpsertJob)

部署一覧情報の配列

Array

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (PersonInChargeForExternalUpsertJob)

仕事担当者情報の配列

Array

externalId	string or null 外部ID
id	string or null ユーザーID

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

集客元情報

externalId	string or null 外部ID
id	string or null 集客元ID

object

フェーズ情報

id

string or null

フェーズID

estimateId

string or null

見積書ID

appointmentIds

Array of strings

仕事日程ID

object

請求書情報

title	string or null 請求書タイトル
unitPrice	string or nulld+(.d+)? 単価

object

仕事失注

selectedLostOrderReasonIds required	Array of strings 仕事失注理由選択
failureReason	string or null 備考

createdAt

string or null <date-time>

作成日

Responses

Response Schema: application/json

required

object

仕事詳細情報

id

required

string

仕事ID

externalId

string or null

外部ID

slug

required

string

管理番号

title

required

string

仕事名

cancelledAt

string or null <date-time>

仕事失注日

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

createdAt

required

string <date-time>

仕事作成日

finishedAt

string or null <date-time>

仕事終了日

expectedOrderAmount

string or nulld+(.d+)?

受注予定金額

expectedOrderDate

string or null <date-time>

受注予定日

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

受注状況

依頼受領 request
見積作成中 before estimating
見積発行済み estimating
完了 ordered
失注 cancelled

jobStatus

required

string

Enum: "completed" "no appointment" "appointment completed" "progress"

仕事状況

日程未定 no appointment
進行中 progress
日程完了 appointment completed
完了 completed

invoiceStatus

required

string

Enum: "cancelled" "partiallyPaid" "paid" "requested" "issued" "waiting"

請求状況

請求前 waiting
請求中 issued
入金済み paid

purchaseOrderStatus

required

string

Enum: "issued" "delivered" "waiting" "ordering"

発注状況

発行済み issued
発注中 ordering
納品済み delivered
未発行 waiting

purchaseOrderPaymentStatus

required

string

Enum: "notReceived" "received" "partiallyPaid" "paid" "waiting"

発注支払状況

請求受領 received
一部支払 partiallyPaid
支払済み paid
請求未受領 waiting

documentStatus

required

string

Enum: "issued" "waiting"

書類状況

発行済み issued
発行前 waiting

isAssignedToMe

required

boolean

仕事担当者または訪問担当者に対象のユーザーIDが含まれているかどうかを示すフラグ

updatedAt

required

string <date-time>

仕事の最終更新日

dataUpdatedAt

required

string <date-time>

仕事に関連する情報の最終更新日 = 最新ログの作成日

required

object

顧客情報

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

useClientAddressForBilling

required

boolean

顧客の住所を請求先住所として使用するかどうかのフラグ

object or null

請求先情報

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

required

object

顧客情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

clientId

required

string

顧客ID

required

Array of objects (ExternalEstimateSimple)

見積書情報の配列

Array

id required	string 見積書ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 見積書タイトル
slug required	string 見積書番号
effectiveDuration required	string 有効期限
issuedAt	string or null <date-time> 見積書発行日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
isArchive required	boolean アーカイブフラグ
orderStatus required	string Enum: "cancelled" "ordered" "estimating" "before estimating" "request" 発行状態作成前 request 作成中 before estimating 発行済み estimating 受注 ordered 失注 cancelled
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

required

Array of objects (ExternalInvoiceSimple)

請求書情報の配列

Array

id required	string 請求書ID
externalId	string or null 外部ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 請求書タイトル
slug required	string 管理番号
dueAt	string or null <date-time> 支払い期限日
note	string or null 備考
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitCostRoundingDigit required	number 原価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitCostRoundingType required	string Enum: "Down" "Up" "Off" 原価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
cost required	stringd+(.d+)? 原価合計金額
issuedAt	string or null <date-time> 請求書発行日
billedAt	string or null <date-time> 請求日
requestedAt	string or null <date-time> ステータスが請求中に更新された日時
paidAt	string or null <date-time> 入金日
partiallyPaidAt	string or null <date-time> 一部入金日
isArchive required	boolean アーカイブ済みかどうか
approvalStatus	string or null Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved" 承認ステータス
estimateId	string or null 紐づいている見積書ID

required

Array of objects (ExternalExpectedCostSimple)

実行予算情報の配列

Array

id required	string 実行予算ID
createdAt required	string <date-time> 作成日
updatedAt required	string <date-time> 更新日
title required	string 実行予算タイトル
taxType	string or null Enum: "TaxIncluded" "TaxExcluded" "TaxExempted" 消費税税込 TaxIncluded 税抜 TaxExcluded 税込（免税） TaxExempted
unitPriceRoundingDigit required	number 単価の端数を処理する桁数小数点第2位: 2 小数点第1位: 1 整数: 0
unitPriceRoundingType required	string Enum: "Down" "Up" "Off" 単価の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
subTotalRoundingType required	string Enum: "Down" "Up" "Off" 小計の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
taxRoundingType required	string Enum: "Down" "Up" "Off" 消費税の端数処理方法切り捨て: Down 切り上げ: Up 四捨五入: Off
slug required	string 管理番号
note	string or null 備考
total required	stringd+(.d+)? 税込合計金額
subTotal required	stringd+(.d+)? 税抜合計金額
salesTax required	stringd+(.d+)? 消費税額
issuedAt	string or null <date-time> 発行日
deletedAt	string or null <date-time> 削除日

required

Array of objects (AppointmentForExternalJob)

仕事日程情報の配列

Array

id

required

string

仕事日程ID

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

required

Array of objects (JobTagForExternalJob)

仕事タグ情報の配列

Array

id required	string 仕事タグID
name required	string 仕事タグ名
shortcode	string or null 短縮形
color required	string 仕事タグの色
isArchive required	boolean アーカイブフラグ trueの場合アーカイブ済み

object or null

仕事タイプ情報

id required	string 仕事タイプID
name required	string 仕事タイプ名
durationMinutes required	number 所要時間
memo	string or null メモ
isActive required	boolean 有効フラグ trueの場合有効
color required	string 仕事タイプの色カラーコードを指定する

required

object

現場情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

required

Array of objects (DivisionForExternalJob)

部署一覧情報の配列

Array

id required	string 部署ID
name required	string 部署名

object or null

集客元情報

id required	string 集客元ID
name required	string 集客元名

required

Array of objects (UserForExternalJob)

仕事担当者情報の配列

Array

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

object or null

収支情報

required

object

収支サマリー

expense required	number 経費
netSales required	number 最終利益
totalProfitRatio required	number 最終利益率
costPrice required	number 原価
sales required	number 売上
grossProfit required	number 粗利
profitRatio required	number 粗利率

memo

string or null

メモ

object or null

支払い方法

id required	string 支払い方法ID
name required	string 支払い方法名

object or null

フェーズ情報

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

object or null

パイプライン情報

id

required

string

パイプラインID

name

required

string

パイプライン名

required

Array of objects (PhaseForExternalJob)

フェーズ情報の配列

Array

id required	string フェーズID
name required	string フェーズ名
type required	string Enum: "Inquiry" "Ordered" "Done" フェーズタイプ営業中 Inquiry 実施前 Ordered 実施後 Done
sortNum required	number 並び順
orderProbability	number or null 受注確度パーセンテージで表す

failureReason

string or null

備考

Array of objects (OrderFailureReasonForExternalJob)

失注理由

Array

apiName	string or null API参照名
reason	string or null 失注理由

Request samples

Payload

Content type

application/json

{"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"company": {"externalId": "string",
"id": "cl2451eh700002gx9ju799nt3"
},
"address": {"externalId": "string",
"id": "cl2451eh700002gx9ju799nat"
},
"contact": {"externalId": "string",
"id": "clsjzuyef0000u0r2626k5e00"
},
"client": {"externalId": "string",
"id": "clsjzuyef0032u2r20l6k3s30"
},
"title": "TESTInc.様/エアコンクリーニング",
"titleFormat": "[{{slug}}] {{clientName}}様",
"memo": "特になし",
"memoMode": "append",
"jobTags": [{"externalId": "string",
"id": "clq5z3bi8008q5p0187stneu4"
}
],
"jobType": {"externalId": "string",
"id": "clexrnhoc00044j01qxgt84c6"
},
"paymentMethod": {"externalId": "string",
"id": "clhe6u5gb00m14d0125nx2cjz"
},
"appointments": [{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"arrivalWindow": {"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
},
"assignments": [{"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
}
],
"title": "作業当日",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"divisions": [{"externalId": "string",
"id": "cl5ais9zo8089015sbda9dhmq"
}
],
"personInChargeUsers": [{"externalId": "string",
"id": "ckz21yyek2147015jhdem6o0h"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"leadSource": {"externalId": "string",
"id": "cl5c0gaoe19534015l29i76dzl"
},
"phase": {"id": "clf7oz88g007w4e01caey9nmy",
"estimateId": "clptk0yf302315o01wq9zbo6g",
"appointmentIds": "cl5c0bcz318351015l39r39wao",
"invoice": {"title": "エアコンクリーニング 見積",
"unitPrice": "10000"
},
"jobLostOrderReasonsAndFailureReason": {"selectedLostOrderReasonIds": ["string"
],
"failureReason": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{"data": {"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"slug": "2024-02-003",
"title": "TESTInc.様/エアコンクリーニング",
"cancelledAt": "2021-06-01T00:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"createdAt": "2021-06-01T00:00:00.000Z",
"finishedAt": "2021-06-07T00:00:00.000Z",
"expectedOrderAmount": "200000",
"expectedOrderDate": "2023-05-05T00:00:00.000Z",
"orderStatus": "ordered",
"jobStatus": "progress",
"invoiceStatus": "paid",
"purchaseOrderStatus": "issued",
"purchaseOrderPaymentStatus": "received",
"documentStatus": "issued",
"isAssignedToMe": true,
"updatedAt": "2023-06-09T00:00:00.000Z",
"dataUpdatedAt": "2023-06-09T00:00:00.000Z",
"contact": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"useClientAddressForBilling": true,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
},
"client": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30"
},
"clientId": "clq5z3bi8008s5p011j24pj6i"
},
"estimates": [{"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress"
}
],
"invoices": [{"id": "clei758p6001u5l01w5ztspw6",
"externalId": "string",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-I01",
"dueAt": "2023-06-30T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"billedAt": "2023-06-01T02:00:00.000Z",
"requestedAt": "2023-06-01T02:00:00.000Z",
"paidAt": "2023-06-05T02:00:00.000Z",
"partiallyPaidAt": "2023-06-05T02:00:00.000Z",
"isArchive": false,
"approvalStatus": "InProgress",
"estimateId": "clptk0yf302315o01wq9zbo6g"
}
],
"expectedCosts": [{"id": "clc5yxs9y000f5mr60iqw61qu",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "備品費",
"taxType": "TaxIncluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"slug": "2023-06-01-I01",
"note": "特になし",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"deletedAt": "2023-06-01T02:00:00.000Z"
}
],
"appointments": [{"id": "cl5c0bcz318351015l39r39wao",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
],
"jobTags": [{"id": "clq5z3bi8008q5p0187stneu4",
"name": "2022-01-03T02:00:00.000Z",
"shortcode": "H",
"color": "#E9967A",
"isArchive": false
}
],
"jobType": {"id": "clexrnhoc00044j01qxgt84c6",
"name": "エアコンクリーニング",
"durationMinutes": 60,
"memo": "壁掛けタイプのエアコンのみ対応",
"isActive": true,
"color": "#FF0999"
},
"address": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
]
},
"divisions": [{"id": "cl5ais9zo8089015sbda9dhmq",
"name": "第一営業部"
}
],
"leadSource": {"id": "cl5c0gaoe19534015l29i76dzl",
"name": "広告会社A"
},
"personInChargeUsers": [{"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
],
"balance": {"summary": {"expense": 100000,
"netSales": 250000,
"totalProfitRatio": 1.24,
"costPrice": 150000,
"sales": 400000,
"grossProfit": 50000,
"profitRatio": 0.125
}
},
"memo": "特になし",
"paymentMethod": {"id": "clhe6u5gb00m14d0125nx2cjz",
"name": "クレジットカード"
},
"phase": {"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
},
"pipeline": {"id": "clkm13i0x00945w01t57rk37i",
"name": "パイプラインB",
"phases": [{"id": "clf7oz88g007w4e01caey9nmy",
"name": "営業中",
"type": "Inquiry",
"sortNum": 1,
"orderProbability": 50
}
]
},
"failureReason": "string",
"orderFailureReasons": [{"apiName": "string",
"reason": "string"
}
]
}
}

顧客

顧客の詳細を取得

顧客の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

顧客ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

顧客の詳細情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

required

object

現場情報

id required	string 現場ID
externalId	string or null 外部ID

required

object

個人情報/客先担当者

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

Response samples

Content type

application/json

{"data": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
},
"contacts": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
}
}

顧客一覧を取得

顧客一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

ids

Array of strings

顧客IDの配列（完全一致）

externalIds

Array of strings

外部IDの配列（完全一致）

isCompany

boolean or null

法人フラグによるフィルタ

isArchive

boolean or null

アーカイブフラグによるフィルタ

Array of objects (IdOrExternalIdReferenceDto)

部署の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

object

作成日の範囲フィルタ

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

更新日の範囲フィルタ

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ClientForExternalFindAllResponse)

顧客情報の配列

Array

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

会社名

phone

string or null

代表電話番号

email

string or null

代表メールアドレス

isCompany

required

boolean

顧客区分（true: 法人, false: 個人）

isArchive

required

boolean

アーカイブフラグ

customFields

object

カスタム項目

divisionId

string or null

顧客担当部署ID

required

Array of objects (AddressSummaryForFindAll)

現場

Array

id required	string 現場ID
externalId	string or null 外部ID

required

Array of objects (ContactSummaryForFindAll)

客先担当者

Array

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（カナ）

firstnameKana

string or null

名（カナ）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

請求先情報

id required	string 請求先ID
name	string or null 請求先名
compellation	string or null 敬称
zipcode	string or null 郵便番号
state	string or null 都道府県
city	string or null 市区町村
address1	string or null 住所1
address2	string or null 住所2

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"ids": ["cl3l7lqsj3303015nraag2rho"
],
"externalIds": ["ext_client_12345"
],
"isCompany": true,
"isArchive": false,
"division": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"updatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
}
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext_client_12345",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"name": "山田 太郎",
"companyName": "株式会社ミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"isCompany": true,
"isArchive": false,
"customFields": {"Text_1": "example"
},
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext_address_12345"
}
],
"contacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext_contact_12345",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "09012345678",
"email": "taro@example.com",
"divisionName": "営業部",
"internalNote": "要注意顧客",
"isArchive": false,
"billingInformation": {"id": "cl3l7lqsj3303015nraag2rho",
"name": "株式会社ミツモア",
"compellation": "様",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
]
}
]
}

顧客（個人）を作成または更新

顧客（個人）を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

externalId

string or null

外部ID

id

string or null

顧客（個人）ID

lastname

string or null

姓

firstname

string or null

名前

lastnameKana

string or null

姓カナ

firstnameKana

string or null

名前カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

集客元情報

externalId	string or null 外部ID
id	string or null 集客元ID

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (AddressForExternalUpsertClient)

現場情報の配列

Array

externalId	string or null 外部ID
id	string or null 現場ID

Responses

Response Schema: application/json

required

object

顧客の詳細情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

required

object

現場情報

id required	string 現場ID
externalId	string or null 外部ID

required

object

個人情報/客先担当者

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

Request samples

Payload

Content type

application/json

{"externalId": "string",
"id": "cl5c0bcz318351015l39r39wao",
"lastname": "string",
"firstname": "string",
"lastnameKana": "string",
"firstnameKana": "string",
"phone": "03-1234-5678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSource": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"company": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvdd"
},
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"addresses": "[{ id: \"address123\" }]"
}

Response samples

Content type

application/json

{"data": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
},
"contacts": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
}
}

顧客（個人）を更新

顧客（個人）を更新するためのAPIです。idまたはexternalIdで指定された顧客が存在しない場合はエラーを返します。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

顧客参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

lastname

string or null

姓

firstname

string or null

名前

lastnameKana

string or null

姓カナ

firstnameKana

string or null

名前カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

集客元情報

externalId	string or null 外部ID
id	string or null 集客元ID

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (AddressForExternalUpsertClient)

現場情報の配列

Array

externalId	string or null 外部ID
id	string or null 現場ID

Responses

Response Schema: application/json

required

object

顧客の詳細情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

required

object

現場情報

id required	string 現場ID
externalId	string or null 外部ID

required

object

個人情報/客先担当者

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

Request samples

Payload

Content type

application/json

{"client": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"lastname": "string",
"firstname": "string",
"lastnameKana": "string",
"firstnameKana": "string",
"phone": "03-1234-5678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSource": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"company": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvdd"
},
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"addresses": "[{ id: \"address123\" }]"
}

Response samples

Content type

application/json

{"data": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
},
"contacts": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
}
}

顧客（法人）を作成または更新

顧客（法人）を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

externalId

string or null

外部ID

id

string or null

顧客（法人）ID

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

集客元情報

externalId	string or null 外部ID
id	string or null 集客元ID

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (AddressForExternalUpsertClient)

現場情報の配列

Array

externalId	string or null 外部ID
id	string or null 現場ID

Array of objects (ContactForExternalUpsertClient)

客先担当者情報の配列

Array

externalId

string or null

外部ID

id

string or null

客先担当者ID

lastname

string or null

客先担当者の姓

firstname

string or null

客先担当者の名前

lastnameKana

string or null

客先担当者の姓カナ

firstnameKana

string or null

客先担当者の名前カナ

phone

string or null

客先担当者の電話番号

email

string or null

客先担当者のメールアドレス

divisionName

string or null

部署名

internalNote

string or null

備考

isArchive

boolean or null

Default: false

アーカイブフラグ

object

請求先情報

name	string or null 請求先名
compellation	string or null 敬称
zipcode	string or null 郵便番号
state	string or null 都道府県
city	string or null 市区町村
address1	string or null 住所1
address2	string or null 住所2

Responses

Response Schema: application/json

required

object

顧客の詳細情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

required

object

現場情報

id required	string 現場ID
externalId	string or null 外部ID

required

object

個人情報/客先担当者

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

Request samples

Payload

Content type

application/json

{"externalId": "string",
"id": "cl5c0bcz318351015l39r39wao",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "03-1234-5678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSource": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"company": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvdd"
},
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"addresses": "[{ id: \"address123\" }]",
"contacts": "[{ id: \"contact123\" }]"
}

Response samples

Content type

application/json

{"data": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
},
"contacts": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
}
}

顧客（法人）を更新

顧客（法人）を更新するためのAPIです。idまたはexternalIdで指定された顧客が存在しない場合はエラーを返します。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

顧客参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

集客元情報

externalId	string or null 外部ID
id	string or null 集客元ID

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (AddressForExternalUpsertClient)

現場情報の配列

Array

externalId	string or null 外部ID
id	string or null 現場ID

Array of objects (ContactForExternalUpdateClient)

客先担当者情報の配列

Array

externalId

string or null

外部ID

id

string or null

客先担当者ID

lastname

string or null

客先担当者の姓

firstname

string or null

客先担当者の名前

lastnameKana

string or null

客先担当者の姓カナ

firstnameKana

string or null

客先担当者の名前カナ

phone

string or null

客先担当者の電話番号

email

string or null

客先担当者のメールアドレス

divisionName

string or null

部署名

internalNote

string or null

備考

isArchive

boolean or null

Default: false

アーカイブフラグ

object

請求先情報

name	string or null 請求先名
compellation	string or null 敬称
zipcode	string or null 郵便番号
state	string or null 都道府県
city	string or null 市区町村
address1	string or null 住所1
address2	string or null 住所2

Responses

Response Schema: application/json

required

object

顧客の詳細情報

id

required

string

顧客ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

顧客名

companyName

string or null

法人名

companyNameKana

string or null

法人名カナ

phone

string or null

電話番号

email

string or null

メールアドレス

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

isCompany

required

boolean

法人フラグ

isArchive

required

boolean

アーカイブフラグ

cutoffDateCode

number or null

Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 99

締め日コード

5日締め: 5
10日締め: 10
15日締め: 15
20日締め: 20
25日締め: 25
月末締め: 99

paymentDateCode

number or null

Enum: 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 199 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 299 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 399 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 499 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 599 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 699 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 799

支払日コード

当月 20日払い: 120
当月 25日払い: 125
当月月末払い: 199
翌月 5日払い: 205
翌月 10日払い: 210
翌月 15日払い: 215
翌月 20日払い: 220
翌月 25日払い: 225
翌月月末払い: 299
翌々月 5日払い: 305
翌々月 10日払い: 310
翌々月 15日払い: 315
翌々月 20日払い: 320
翌々月 25日払い: 325
翌々月月末払い: 399

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

leadSourceId

string or null

集客元のID

divisionId

string or null

部署ID

required

object

現場情報

id required	string 現場ID
externalId	string or null 外部ID

required

object

個人情報/客先担当者

id

required

string

客先担当者ID

externalId

string or null

外部ID

lastname

required

string

姓

firstname

string or null

名

lastnameKana

string or null

姓（ひらがな）

firstnameKana

string or null

名（ひらがな）

phone

string or null

電話番号

email

string or null

メールアドレス

divisionName

string or null

部署名

internalNote

string or null

社内メモ

isArchive

required

boolean

アーカイブフラグ

object or null

id required	string 請求情報ID
name	string or null 請求情報の宛先名
compellation	string or null Enum: "様" "殿" "御中" 請求情報の敬称
zipcode	string or null 請求情報の郵便番号
state	string or null 請求情報の都道府県
city	string or null 請求情報の市区町村
address1	string or null 請求情報の住所1
address2	string or null 請求情報の住所2

Request samples

Payload

Content type

application/json

{"client": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "03-1234-5678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSource": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"company": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvdd"
},
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"addresses": "[{ id: \"address123\" }]",
"contacts": "[{ id: \"contact123\" }]"
}

Response samples

Content type

application/json

{"data": {"id": "clsjzuyef0032u2r20l6k3s30",
"externalId": "string",
"createdAt": "2020-10-23T01:08:01.109Z",
"updatedAt": "2020-10-23T01:08:01.109Z",
"name": "string",
"companyName": "株式会社ミツモア",
"companyNameKana": "カブシキガイシャミツモア",
"phone": "0312345678",
"email": "example@meetsmore.com",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"isCompany": true,
"isArchive": false,
"cutoffDateCode": 99,
"paymentDateCode": 199,
"customFields": {"property1": "string",
"property2": "string"
},
"leadSourceId": "cl2457uox0201frx9puwnqzxm",
"divisionId": "dvzuyef0032u2r20l6k3s30",
"addresses": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
},
"contacts": {"id": "clsjzuyef0000u0r2626k5e00",
"externalId": "string",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "やまだ",
"firstnameKana": "たろう",
"phone": "09000000000",
"email": "example@example.com",
"divisionName": "営業部",
"internalNote": "これは社内メモです。",
"isArchive": false,
"billingInformation": {"id": "clsjzuyef0020u0r3626k5e32",
"name": "山田太郎",
"compellation": "様",
"zipcode": "1234567",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階"
}
}
}
}

顧客（個人）をアーカイブ

顧客（個人）をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 顧客ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string クライアントID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

顧客（個人）のアーカイブを解除

リクエストしたID/外部IDで対象の1件の顧客（個人）のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 顧客ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string クライアントID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

顧客（法人）をアーカイブ

顧客（法人）をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 顧客ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string クライアントID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

顧客（法人）のアーカイブを解除

リクエストしたID/外部IDで対象の1件の顧客（法人）のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 顧客ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string クライアントID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

収支管理

実績(Actual)の更新

指定した案件の実績(Actual)を更新します。profitLines / lossLines は全置換。documentTemplate は未送信の場合のみ既存値を維持。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

対象案件参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

書類テンプレート参照。未指定は既存維持、null でクリア。。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

required

Array of objects (ExternalUpdateBalanceActualLineDto)

収入明細（必須・全置換）

Array

label

string or null

項目名

unitPrice

string or null^-?\d+(\.\d+)?$

単価

quantity

string or null^-?\d+(\.\d+)?$

数量

note

string or null

備考

lineType

required

string (BalanceLineType)

Enum: "Group" "Item" "Text"

行の種類（Group/Item/Text）

discountPrice

string or null^-?\d+(\.\d+)?$

値引き額

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

children

Array of objects (ExternalUpdateBalanceActualLineDto)

子要素リスト（階層構造用）

required

Array of objects (ExternalUpdateBalanceActualLineDto)

支出明細（必須・全置換）

Array

label

string or null

項目名

unitPrice

string or null^-?\d+(\.\d+)?$

単価

quantity

string or null^-?\d+(\.\d+)?$

数量

note

string or null

備考

lineType

required

string (BalanceLineType)

Enum: "Group" "Item" "Text"

行の種類（Group/Item/Text）

discountPrice

string or null^-?\d+(\.\d+)?$

値引き額

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

children

Array of objects (ExternalUpdateBalanceActualLineDto)

子要素リスト（階層構造用）

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ

Request samples

Payload

Content type

application/json

{"job": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"documentTemplate": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"profitLines": [{"label": "材料費",
"unitPrice": "10000",
"quantity": "1",
"note": "予備費含む",
"lineType": "Group",
"discountPrice": "0",
"customFields": {"property1": "string",
"property2": "string"
},
"children": [{ }
]
}
],
"lossLines": [{"label": "材料費",
"unitPrice": "10000",
"quantity": "1",
"note": "予備費含む",
"lineType": "Group",
"discountPrice": "0",
"customFields": {"property1": "string",
"property2": "string"
},
"children": [{ }
]
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true
}

建物

建物を作成または更新

建物を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

externalId

string or null

外部ID

id

string or null

建物ID

name

string or null

建物名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

電話番号

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

部署情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

Array of objects (BuildingOwnerForExternalUpsertBuilding)

Responses

Response Schema: application/json

required

object

建物の詳細情報

id

required

string

建物ID

externalId

string or null

外部ID

tenantId

required

string

テナントID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

建物名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

部署情報

id required	string 部署ID
externalId	string or null 外部ID

Array of objects or null (BuildingOwnerForExternalBuilding)

Request samples

Payload

Content type

application/json

{"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid",
"name": "青山ビルディング",
"zipcode": "123-4567",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"phone": "03-1234-5678",
"customFields": {"property1": "string",
"property2": "string"
},
"company": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvdd"
},
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"owners": [{"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid",
"tags": [{"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
}
]
}
],
"addresses": [{"externalId": "string",
"id": "cl2451eh700002gx9ju799nat"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"tenantId": "tenantId123",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "青山ビルディング",
"zipcode": "123-4567",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"phone": "03-1234-5678",
"customFields": {"property1": "string",
"property2": "string"
},
"division": {"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string"
},
"owners": [{"id": "clhhayfgu0003015kcsx0hvid",
"externalId": "string",
"tags": [{"id": "clhhayfgu0003015kcsx0hvid"
}
]
}
],
"addresses": [{"id": "cl2451eh700002gx9ju799nat",
"externalId": "string"
}
]
}
}

建物をアーカイブ

建物をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 建物ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 建物ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "building-123",
"isArchive": true
}

建物のアーカイブを解除

リクエストしたID/外部IDで対象の1件の建物のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 建物ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 建物ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "building-123",
"isArchive": true
}

現場

現場の詳細を取得

現場の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cl3l7lqsj3303015nraag2rho

現場ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

現場の詳細情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

Array of objects (JobForExternalAddress)

仕事の配列

Array

id

required

string

仕事ID

Array of objects (ClientForExternalAddress)

顧客の配列

Array

id

required

string

顧客ID

Array of objects (EquipmentForExternalAddress)

機器の配列

Array

id

required

string

機器ID

Response samples

Content type

application/json

{"data": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
],
"jobs": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"clients": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"equipments": [{"id": "cl3l7lqsj3303015nraag2rho"
}
]
}
}

現場の詳細を取得（外部ID）

外部ID（externalId）で現場の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: ext_address_12345

現場の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

現場の詳細情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

Array of objects (JobForExternalAddress)

仕事の配列

Array

id

required

string

仕事ID

Array of objects (ClientForExternalAddress)

顧客の配列

Array

id

required

string

顧客ID

Array of objects (EquipmentForExternalAddress)

機器の配列

Array

id

required

string

機器ID

Response samples

Content type

application/json

{"data": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
],
"jobs": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"clients": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"equipments": [{"id": "cl3l7lqsj3303015nraag2rho"
}
]
}
}

現場一覧を取得

現場一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

ids

Array of strings or null

現場IDの配列（完全一致）

externalIds

Array of strings or null

外部IDの配列（完全一致）

managementNumbers

Array of strings or null

管理番号の配列（完全一致）

name

string or null

現場名（完全一致）

nameKana

string or null

現場名カナ（完全一致）

isArchive

boolean or null

アーカイブフラグによるフィルタ

Array of objects (IdOrExternalIdReferenceDto)

仕事の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

顧客の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

部署の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

建物の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

法人の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

object

作成日の範囲フィルタ

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

更新日の範囲フィルタ

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalAddressForFindAll)

現場情報の配列

Array

id

required

string

現場ID

externalId

string or null

外部ID

managementNumber

string or null

管理番号

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

companyId

string or null

法人ID

required

Array of objects (AddressTagSummaryForFindAll)

現場タグの配列（id のみ）

Array

id

required

string

現場タグID

required

Array of objects (JobSummaryForFindAll)

仕事の配列（id / externalId のみ）

Array

id required	string ID
externalId	string or null 外部ID

required

Array of objects (ClientSummaryForFindAll)

顧客の配列（id / externalId のみ）

Array

id required	string ID
externalId	string or null 外部ID

required

Array of objects (EquipmentSummaryForFindAll)

機器の配列（id / externalId のみ）

Array

id required	string ID
externalId	string or null 外部ID

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"ids": ["cl3l7lqsj3303015nraag2rho"
],
"externalIds": ["ext_address_12345"
],
"managementNumbers": ["ADR-2025-0001"
],
"name": "山田様邸",
"nameKana": "ヤマダサマテイ",
"isArchive": false,
"job": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"client": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"division": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"building": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"company": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"updatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
}
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"managementNumber": "ADR-2025-0001",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"companyId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"jobs": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "string"
}
],
"clients": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "string"
}
],
"equipments": [{"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "string"
}
]
}
]
}

現場を作成または更新

現場を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id

string or null

現場ID

externalId

string or null

外部ID

name

string or null

現場名

nameKana

string or null

現場名のカナ

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

電話番号

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

部署情報

externalId	string or null 外部ID
id	string or null 部署ID

object

建物情報

externalId	string or null 外部ID
id	string or null 建物ID

Array of objects (AddressTagForExternalUpsertAddress)

現場タグ情報の配列

Array

id	string or null 現場タグID

Array of objects (ClientForExternalUpsertAddress)

顧客情報の配列

Array

externalId	string or null 外部ID
id	string or null 顧客ID

Array of objects (JobForExternalUpsertAddress)

仕事情報の配列

Array

externalId	string or null 外部ID
id	string or null 仕事ID

Array of objects (EquipmentForExternalUpsertAddress)

機器情報の配列

Array

externalId	string or null 外部ID
id	string or null 機器ID

Responses

Response Schema: application/json

required

object

現場の詳細情報

id

required

string

現場ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

name

required

string

現場名

nameKana

string or null

現場のカナ名

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

phone

string or null

現場の電話番号

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

required

boolean

アーカイブ済みかどうか

divisionId

string or null

部署ID

buildingId

string or null

建物ID

required

Array of objects (AddressTagForExternalAddress)

現場タグ情報の配列

Array

id required	string 現場タグID
name required	string 現場タグ名
color required	string 現場タグの色カラーコードを指定する

Array of objects (JobForExternalAddress)

仕事の配列

Array

id

required

string

仕事ID

Array of objects (ClientForExternalAddress)

顧客の配列

Array

id

required

string

顧客ID

Array of objects (EquipmentForExternalAddress)

機器の配列

Array

id

required

string

機器ID

Request samples

Payload

Content type

application/json

{"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"name": "作業エリア",
"nameKana": "サギョウエリア",
"zipcode": "104-0061",
"state": "東京都",
"city": "新宿区",
"address1": "西新宿2-8-1",
"address2": "ビル名や部屋番号",
"phone": "03-1234-5678",
"customFields": {"property1": "string",
"property2": "string"
},
"company": "clhhayfgu0003015kcsx0hvdd",
"division": "clhhayfgu0003015kcsx0hvid",
"building": "clhhayfgu0003015kcsx0hvid",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"clients": [{"externalId": "string",
"id": "clzjnq0j200vw8l1wxic5dj15"
}
],
"jobs": [{"externalId": "string",
"id": "clzjnq14x0007b3ucbqzy03iw"
}
],
"equipments": [{"externalId": "string",
"id": "clzkzxeg0000yca7w5daeqshx"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "cl2451eh700002gx9ju799nat",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"name": "山田様邸",
"nameKana": "ヤマダ タロウ",
"zipcode": "1040061",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"phone": "09000000000",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false,
"divisionId": "string",
"buildingId": "string",
"addressTags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "エレベーターなし",
"color": "#FF0000"
}
],
"jobs": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"clients": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"equipments": [{"id": "cl3l7lqsj3303015nraag2rho"
}
]
}
}

現場をアーカイブ

現場をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 現場ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 現場ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

現場のアーカイブを解除

リクエストしたID/外部IDで対象の1件の現場のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 現場ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 現場ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

見積書

見積書の詳細を取得

見積書の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

見積書ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

見積書詳細情報

id

required

string

見積書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

見積書タイトル

slug

required

string

見積書番号

effectiveDuration

required

string

有効期限

issuedAt

string or null <date-time>

見積書発行日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

isArchive

required

boolean

アーカイブフラグ

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

発行状態

作成前 request
作成中 before estimating
発行済み estimating
受注 ordered
失注 cancelled

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

jobId

required

string

仕事のID

required

Array of objects (EstimateLineForExternalEstimate)

見積書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Response samples

Content type

application/json

{"data": {"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress",
"jobId": "clptk0yf302315o01wq9zbo6g",
"estimateLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}
}

見積書一覧を取得

見積書一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

jobIds

Array of strings

仕事ID

addressIds

Array of strings

現場ID

clientIds

Array of strings

顧客ID

object

作成日の範囲

start	string or null <date-time> 発行日の範囲開始日時
end	string or null <date-time> 発行日の範囲終了日時

slug

string or null

見積書番号

isArchive

boolean or null

アーカイブフラグによるフィルタ trueの場合アーカイブ済みの見積書のみ、falseの場合非アーカイブの見積書のみ、未指定の場合は全件取得 nullを指定した場合はバリデーションエラーとなります

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalEstimateFull)

仕事情報の配列

Array

id

required

string

見積書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

見積書タイトル

slug

required

string

見積書番号

effectiveDuration

required

string

有効期限

issuedAt

string or null <date-time>

見積書発行日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

isArchive

required

boolean

アーカイブフラグ

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

発行状態

作成前 request
作成中 before estimating
発行済み estimating
受注 ordered
失注 cancelled

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

jobId

required

string

仕事のID

required

Array of objects (EstimateLineForExternalEstimate)

見積書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"jobIds": ["string"
],
"addressIds": ["string"
],
"clientIds": ["string"
],
"issuedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"slug": "2024-02-003-E01",
"isArchive": false
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress",
"jobId": "clptk0yf302315o01wq9zbo6g",
"estimateLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
]
}
]
}

見積書の承認ステータスを更新

見積書の承認ステータスを承認・否認に更新するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

見積書ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

approvalStatus

required

string

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted"

見積書承認ステータス

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"approvalStatus": "Approved"
}

Response samples

Content type

application/json

{ }

見積書を作成

見積書を新規作成するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

title

required

string

タイトル

effectiveDuration

required

string

有効期限（YYYY/MM/DD）

issuedAt

string or null <date-time>

発行日（未発行はnull）

note

string or null

備考

jobId

required

string

ジョブID

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分（TaxIncluded/TaxExcluded/TaxExempted）

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

clientId

string or null

取引先ID

contactId

string or null

担当者ID

unitCostRoundingType

string

Enum: "Down" "Up" "Off"

原価の端数処理（Down/Up/Off）

unitCostRoundingDigit

number [ 0 .. 2 ]

原価の端数桁（0/1/2）

unitPriceRoundingType

string

Enum: "Down" "Up" "Off"

単価の端数処理（Down/Up/Off）

unitPriceRoundingDigit

number [ 0 .. 2 ]

単価の端数桁（0/1/2）

subTotalRoundingType

string

Enum: "Down" "Up" "Off"

小計の端数処理（Down/Up/Off）

taxRoundingType

string

Enum: "Down" "Up" "Off"

消費税の端数処理（Down/Up/Off）

required

Array of objects (ExternalCreateEstimateLineDto)

見積明細（1行以上）

Array

label

required

string

品名

quantity

required

string^-?\d+(\.\d+)?$

数量（Decimal文字列または数値）

unitPrice

required

string^-?\d+(\.\d+)?$

単価（Decimal文字列または数値）

unitCost

string or null^-?\d+(\.\d+)?$

原価（未指定はnull）

unitName

string or null

単位

priceBookItemId

string or null

価格表アイテムID

originalUnitPrice

string or null^-?\d+(\.\d+)?$

価格表の元単価

originalUnitCost

string or null^-?\d+(\.\d+)?$

価格表の元原価

note

string or null

明細備考

internalNote

string or null

社内メモ

taxCode

string or null

税コード（例: 001=課税10%）

unitListPrice

string or null^-?\d+(\.\d+)?$

上代。この値が指定されている場合、unitListPriceStringは送信しない。unitListPriceとunitListPriceStringが共に未指定の場合、エラー。

unitListPriceString

string or null

上代（文字列）。この値が指定されている場合、unitListPriceは送信しない。unitListPriceとunitListPriceStringが共に未指定の場合、エラー。

isTextLine

required

boolean

Default: false

テキスト行フラグ

modelName

string or null

型番

manufacturerId

string or null

メーカーID

discountPrice

string or null^-?\d+(\.\d+)?$

値引額

splitBillingOriginalUnitPrice

string or null^-?\d+(\.\d+)?$

分割請求用元単価

billedAmount

string or null^-?\d+(\.\d+)?$

請求済金額

progressInvoiceDetailLineId

string or null

出来高明細行ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalCreateEstimateTagDto)

タグ（最大50件）

Array

name required	string タグ名（Web表示: タグ）
color required	string タグ色（HEX）

Responses

Response Schema: application/json

required

object

見積書詳細情報

id

required

string

見積書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

見積書タイトル

slug

required

string

見積書番号

effectiveDuration

required

string

有効期限

issuedAt

string or null <date-time>

見積書発行日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

isArchive

required

boolean

アーカイブフラグ

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

発行状態

作成前 request
作成中 before estimating
発行済み estimating
受注 ordered
失注 cancelled

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

jobId

required

string

仕事のID

required

Array of objects (EstimateLineForExternalEstimate)

見積書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Request samples

Payload

Content type

application/json

{"title": "○○工事 見積書",
"effectiveDuration": "2025/12/31",
"issuedAt": "2025-01-01T00:00:00.000Z",
"note": "string",
"jobId": "idを指定",
"taxType": "TaxExcluded",
"customFields": {"property1": "string",
"property2": "string"
},
"clientId": "idを指定",
"contactId": "idを指定",
"unitCostRoundingType": "Down",
"unitCostRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"estimateLines": [{"label": "基礎工事",
"quantity": "10",
"unitPrice": "5000",
"unitCost": "3000",
"unitName": "式",
"priceBookItemId": "idを指定",
"originalUnitPrice": "5000",
"originalUnitCost": "3000",
"note": "string",
"internalNote": "string",
"taxCode": "001",
"unitListPrice": "5000",
"unitListPriceString": "5000",
"isTextLine": false,
"modelName": "R22LJXS",
"manufacturerId": "idを指定",
"discountPrice": "0",
"splitBillingOriginalUnitPrice": "5000",
"billedAmount": "0",
"progressInvoiceDetailLineId": "idを指定",
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"tags": [{"name": "重要",
"color": "#e43"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress",
"jobId": "clptk0yf302315o01wq9zbo6g",
"estimateLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}
}

見積書を更新（差分）

見積書を更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

更新対象の見積書参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

取引先参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

担当者参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

title

string or null

タイトル

effectiveDuration

string or null

有効期限（YYYY/MM/DD）

issuedAt

string or null <date-time>

発行日（未発行はnull）

note

string or null

備考

taxType

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分（TaxIncluded/TaxExcluded/TaxExempted）

unitCostRoundingType

string (RoundingType)

Enum: "Down" "Up" "Off"

unitCostRoundingDigit

number

unitPriceRoundingType

string (RoundingType)

Enum: "Down" "Up" "Off"

unitPriceRoundingDigit

number

subTotalRoundingType

string (RoundingType)

Enum: "Down" "Up" "Off"

taxRoundingType

string (RoundingType)

Enum: "Down" "Up" "Off"

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalUpdateEstimateLineDto)

見積明細。指定時は全置換

Array

object

価格表アイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

メーカー参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

label

required

string

品名

quantity

required

string^-?\d+(\.\d+)?$

数量

unitPrice

required

string^-?\d+(\.\d+)?$

単価

unitCost

string or null^-?\d+(\.\d+)?$

原価（未指定はnull）

unitName

string or null

単位

originalUnitPrice

string or null^-?\d+(\.\d+)?$

価格表の元単価

originalUnitCost

string or null^-?\d+(\.\d+)?$

価格表の元原価

note

string or null

明細備考

internalNote

string or null

社内メモ

taxCode

string or null

税コード（例: 001=課税10%）

unitListPrice

string or null^-?\d+(\.\d+)?$

上代

unitListPriceString

string or null

上代（文字列）

isTextLine

required

boolean

Default: false

テキスト行フラグ

modelName

string or null

型番

discountPrice

string or null^-?\d+(\.\d+)?$

値引額

splitBillingOriginalUnitPrice

string or null^-?\d+(\.\d+)?$

分割請求用元単価

billedAmount

string or null^-?\d+(\.\d+)?$

請求済金額

progressInvoiceDetailLineId

string or null

出来高明細行ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalUpdateEstimateTagDto)

タグ（指定時の扱いは内部仕様に準拠）

Array

name required	string タグ名
color required	string タグ色（HEX）

Responses

Response Schema: application/json

required

object

見積書詳細情報

id

required

string

見積書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

見積書タイトル

slug

required

string

見積書番号

effectiveDuration

required

string

有効期限

issuedAt

string or null <date-time>

見積書発行日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

isArchive

required

boolean

アーカイブフラグ

orderStatus

required

string

Enum: "cancelled" "ordered" "estimating" "before estimating" "request"

発行状態

作成前 request
作成中 before estimating
発行済み estimating
受注 ordered
失注 cancelled

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

jobId

required

string

仕事のID

required

Array of objects (EstimateLineForExternalEstimate)

見積書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Request samples

Payload

Content type

application/json

{"estimate": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"client": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"contact": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"title": "string",
"effectiveDuration": "2025/12/31",
"issuedAt": "2019-08-24T14:15:22Z",
"note": "string",
"taxType": "TaxIncluded",
"unitCostRoundingType": "Down",
"unitCostRoundingDigit": 0,
"unitPriceRoundingType": "Down",
"unitPriceRoundingDigit": 0,
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"customFields": {"property1": "string",
"property2": "string"
},
"estimateLines": [{"priceBookItem": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"label": "string",
"quantity": "10",
"unitPrice": "5000",
"unitCost": "3000",
"unitName": "式",
"originalUnitPrice": "5000",
"originalUnitCost": "3000",
"note": "string",
"internalNote": "string",
"taxCode": "string",
"unitListPrice": "string",
"unitListPriceString": "string",
"isTextLine": false,
"modelName": "string",
"discountPrice": "0",
"splitBillingOriginalUnitPrice": "5000",
"billedAmount": "0",
"progressInvoiceDetailLineId": "string",
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"tags": [{"name": "string",
"color": "#RRGGBB"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "clptk0yf302315o01wq9zbo6g",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-E01",
"effectiveDuration": "発行日から30日間",
"issuedAt": "2023-06-01T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"isArchive": false,
"orderStatus": "ordered",
"approvalStatus": "InProgress",
"jobId": "clptk0yf302315o01wq9zbo6g",
"estimateLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}
}

請求書

請求書の詳細を取得

請求書の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

請求書ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

請求書の詳細情報

id

required

string

請求書ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

請求書タイトル

slug

required

string

管理番号

dueAt

string or null <date-time>

支払い期限日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

issuedAt

string or null <date-time>

請求書発行日

billedAt

string or null <date-time>

請求日

requestedAt

string or null <date-time>

ステータスが請求中に更新された日時

paidAt

string or null <date-time>

入金日

partiallyPaidAt

string or null <date-time>

一部入金日

isArchive

required

boolean

アーカイブ済みかどうか

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

承認ステータス

estimateId

string or null

紐づいている見積書ID

jobId

required

string

仕事ID

required

Array of objects (CommonAccountingLine)

請求書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Response samples

Content type

application/json

{"data": {"id": "clei758p6001u5l01w5ztspw6",
"externalId": "string",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-I01",
"dueAt": "2023-06-30T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"billedAt": "2023-06-01T02:00:00.000Z",
"requestedAt": "2023-06-01T02:00:00.000Z",
"paidAt": "2023-06-05T02:00:00.000Z",
"partiallyPaidAt": "2023-06-05T02:00:00.000Z",
"isArchive": false,
"approvalStatus": "InProgress",
"estimateId": "clptk0yf302315o01wq9zbo6g",
"jobId": "string",
"invoiceLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}
}

請求書の承認ステータスを更新

請求書の承認ステータスを承認・否認に更新するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

請求書ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

approvalStatus

required

string

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted"

請求書承認ステータス

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"approvalStatus": "Approved"
}

Response samples

Content type

application/json

{ }

請求書を更新（差分）

未送信キーは不変。invoiceLines 指定時のみ全置換。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

更新対象の請求書参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

取引先参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

請求先担当者参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

object or null

ドキュメントテンプレート参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

title

string or null

タイトル

dueAt

string or null <date-time>

支払期限日

billedAt

string or null <date-time>

請求日

note

string or null

備考

taxType

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分（TaxIncluded/TaxExcluded/TaxExempted）

unitCostRoundingType

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

unitCostRoundingDigit

number [ 0 .. 2 ]

原価の端数を処理する桁数（0〜2）

unitPriceRoundingType

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

unitPriceRoundingDigit

number [ 0 .. 2 ]

単価の端数を処理する桁数（0〜2）

subTotalRoundingType

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

string

Enum: "Down" "Up" "Off"

税の端数処理方法

internalNote

string or null

社内メモ

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalUpdateInvoiceLineDto)

請求書明細。指定時は全置換

Array

object

価格表アイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

メーカー参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

label

required

string

品名

quantity

required

string^-?\d+(\.\d+)?$

数量

unitPrice

required

string^-?\d+(\.\d+)?$

単価

unitCost

string or null^-?\d+(\.\d+)?$

原価（未指定はnull）

unitName

string or null

単位

originalUnitPrice

string or null^-?\d+(\.\d+)?$

価格表の元単価

originalUnitCost

string or null^-?\d+(\.\d+)?$

価格表の元原価

note

string or null

明細備考

internalNote

string or null

社内メモ

taxCode

string or null

税コード（例: 001=課税10%）

unitListPrice

string or null^-?\d+(\.\d+)?$

上代

unitListPriceString

string or null

上代（文字列）

isTextLine

required

boolean

Default: false

テキスト行フラグ

modelName

string or null

型番

discountPrice

string or null^-?\d+(\.\d+)?$

値引額

splitBillingOriginalUnitPrice

string or null^-?\d+(\.\d+)?$

分割請求用元単価

billedAmount

string or null^-?\d+(\.\d+)?$

請求済金額

progressInvoiceDetailLineId

string or null

出来高明細行ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalUpdateInvoiceTagDto)

タグ（指定時の扱いは内部仕様に準拠）

Array

name required	string タグ名
color required	string タグ色（HEX）

Responses

Response Schema: application/json

required

object

請求書の詳細情報

id

required

string

請求書ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

title

required

string

請求書タイトル

slug

required

string

管理番号

dueAt

string or null <date-time>

支払い期限日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

unitCostRoundingDigit

required

number

原価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitCostRoundingType

required

string

Enum: "Down" "Up" "Off"

原価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

小数点第2位: 2
小数点第1位: 1
整数: 0

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

切り捨て: Down
切り上げ: Up
四捨五入: Off

total

required

stringd+(.d+)?

税込合計金額

subTotal

required

stringd+(.d+)?

税抜合計金額

salesTax

required

stringd+(.d+)?

消費税額

cost

required

stringd+(.d+)?

原価合計金額

issuedAt

string or null <date-time>

請求書発行日

billedAt

string or null <date-time>

請求日

requestedAt

string or null <date-time>

ステータスが請求中に更新された日時

paidAt

string or null <date-time>

入金日

partiallyPaidAt

string or null <date-time>

一部入金日

isArchive

required

boolean

アーカイブ済みかどうか

approvalStatus

string or null

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted" "Draft" "DeletedAfterApproved"

承認ステータス

estimateId

string or null

紐づいている見積書ID

jobId

required

string

仕事ID

required

Array of objects (CommonAccountingLine)

請求書明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

unitPrice

string or nulld+(.d+)?

単価

unitCost

string or nulld+(.d+)?

原価

quantity

string or nulld+(.d+)?

数量

keyPath

required

string

ドット区切りのパス

taxCode

string or null

税区分コード（未入力の場合は001とみなす）

課税売上10%　001
課税売上8%（軽）　003
非課税売上　091
対象外売上　092

unitName

string or null

単位

object or null

価格表アイテム情報

id

required

string

価格表アイテムID

name

required

string

価格表アイテム名

modelName

string or null

価格表アイテム型番

object or null

価格表アイテムメーカー情報

id required	string メーカーID
name required	string メーカー名

manufacturerId

string or null

価格表アイテムメーカーID

object or null

価格表アイテムカテゴリ情報

id required	string カテゴリID
name required	string カテゴリ名
code required	string カテゴリコード

categoryId

string or null

価格表アイテムカテゴリID

unitPrice

required

stringd+(.d+)?

単価

unitCost

required

stringd+(.d+)?

原価

unitName

string or null

単位

note

string or null

備考

internalNote

string or null

社内メモ

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

associated

string or null

Deprecated

関連する価格表アイテムID配列

parentIds

string or null

関連する価格表アイテムID配列

priceBookItemId

string or null

価格表アイテムID

note

string or null

備考

internalNote

string or null

社内メモ

isTextLine

required

boolean

テキスト行フラグ

sortNum

number or null

並び順

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Request samples

Payload

Content type

application/json

{"invoice": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"client": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"contact": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"documentTemplate": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"title": "string",
"dueAt": "2019-08-24T14:15:22Z",
"billedAt": "2019-08-24T14:15:22Z",
"note": "string",
"taxType": "TaxIncluded",
"unitCostRoundingType": "Down",
"unitCostRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"unitPriceRoundingDigit": 2,
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"internalNote": "string",
"customFields": {"property1": "string",
"property2": "string"
},
"invoiceLines": [{"priceBookItem": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"label": "string",
"quantity": "10",
"unitPrice": "5000",
"unitCost": "3000",
"unitName": "式",
"originalUnitPrice": "5000",
"originalUnitCost": "3000",
"note": "string",
"internalNote": "string",
"taxCode": "string",
"unitListPrice": "string",
"unitListPriceString": "string",
"isTextLine": false,
"modelName": "string",
"discountPrice": "0",
"splitBillingOriginalUnitPrice": "5000",
"billedAmount": "0",
"progressInvoiceDetailLineId": "string",
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"tags": [{"name": "string",
"color": "#RRGGBB"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "clei758p6001u5l01w5ztspw6",
"externalId": "string",
"createdAt": "2023-06-01T00:00:00.000Z",
"updatedAt": "2023-06-01T00:00:00.000Z",
"title": "string",
"slug": "2024-02-003-I01",
"dueAt": "2023-06-30T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"unitCostRoundingDigit": 2,
"unitCostRoundingType": "Off",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Off",
"subTotalRoundingType": "Off",
"taxRoundingType": "Off",
"total": "11000",
"subTotal": "10000",
"salesTax": "1000",
"cost": "5000",
"issuedAt": "2023-06-01T00:00:00.000Z",
"billedAt": "2023-06-01T02:00:00.000Z",
"requestedAt": "2023-06-01T02:00:00.000Z",
"paidAt": "2023-06-05T02:00:00.000Z",
"partiallyPaidAt": "2023-06-05T02:00:00.000Z",
"isArchive": false,
"approvalStatus": "InProgress",
"estimateId": "clptk0yf302315o01wq9zbo6g",
"jobId": "string",
"invoiceLines": [{"id": "cm3nwvnz2000bjzsgmqrc5su0",
"label": "清掃代",
"unitPrice": "10000",
"unitCost": "5000",
"quantity": "1",
"keyPath": "fb9c0b29-3685-4c67-a5a5-ad33a75d1c74.962db167-8c0b-41d5-b9c7-6f99fd4d1456",
"taxCode": "003",
"unitName": "件",
"priceBookItem": {"id": "clptk15w602335o01d9fdr0g8",
"name": "string",
"modelName": "R22LJXS",
"manufacturer": {"id": "cl5c0j27d20027015lkcfehwvt",
"name": "ダイキン"
},
"manufacturerId": "cl5c0j27d20027015lkcfehwvt",
"category": {"id": "cl5c4y3av7540015j9nhy0xdw",
"name": "室外機",
"code": "EXT"
},
"categoryId": "cl5c4y3av7540015j9nhy0xdw",
"unitPrice": 10000,
"unitCost": "5000",
"unitName": "件",
"note": "特になし",
"internalNote": "特になし",
"customFields": {"property1": "string",
"property2": "string"
},
"associated": "[clptk15w602335o01d9fdr0g8]",
"parentIds": "[clptk15w602335o01d9fdr0g8]"
},
"priceBookItemId": "clptk15w602335o01d9fdr0g8",
"note": "特になし",
"internalNote": "特になし",
"isTextLine": false,
"sortNum": 1,
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}
}

Preview PDF

API to preview PDF

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id

required

string

Responses

Request samples

Payload

Content type

application/json

{"id": "string"
}

Response samples

400
401
404
405
500

Content type

application/json

{"statusCode": 400,
"message": "リクエストが不正です"
}

領収書

領収書の承認ステータスを更新

領収書の承認ステータスを承認・否認に更新するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

領収書ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

approvalStatus

required

string

Enum: "InProgress" "Approved" "SentBack" "Rejected" "Deleted"

領収書承認ステータス

Responses

Response Schema: application/json

object

Request samples

Payload

Content type

application/json

{"approvalStatus": "Approved"
}

Response samples

Content type

application/json

{ }

仕事日程

仕事日程の詳細を取得

仕事日程の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cm5lvz5q50132he57wdc1gbmx

仕事日程ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

仕事日程の詳細情報

id

required

string

仕事日程ID

externalId

string or null

外部ID

jobId

required

string

仕事ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isArchive

required

boolean

アーカイブフラグ trueの場合は仕事日程がアーカイブされている

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

Response samples

Content type

application/json

{"data": {"id": "cl5c0bcz318351015l39r39wao",
"externalId": "cl5c0bcz318351015l39r39wao",
"jobId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isArchive": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
}

仕事日程を更新（内部ID）

内部IDで仕事日程を指定して更新するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cm5lvz5q50132he57wdc1gbmx

仕事日程ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

externalId

string or null

外部ID

startTime

string <date-time>

仕事日程開始日時

endTime

string <date-time>

仕事日程終了日時

acceptedAt

string or null <date-time>

検収日

title

string or null

仕事日程タイトル

allDay

boolean

終日フラグ。trueの場合は終日の仕事とみなす

isFixed

boolean

仕事日程が確定しているかどうかのフラグ

isStartDateFixed

boolean

仕事日程の開始日付が確定しているかどうかのフラグ

object

仕事参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

到着時間帯参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

アサインするユーザー参照

Array

id	string プロワンが発行したID
externalId	string 外部ID

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

仕事日程の詳細情報

id

required

string

仕事日程ID

externalId

string or null

外部ID

jobId

required

string

仕事ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isArchive

required

boolean

アーカイブフラグ trueの場合は仕事日程がアーカイブされている

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

Request samples

Payload

Content type

application/json

{"externalId": "ext-appointment-12345",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"title": "作業当日",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"job": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"arrivalWindow": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"assignments": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl5c0bcz318351015l39r39wao",
"externalId": "cl5c0bcz318351015l39r39wao",
"jobId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isArchive": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
}

仕事日程の一覧を取得

仕事日程のID一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

ids

Array of strings

仕事日程ID

externalIds

Array of strings

仕事日程外部ID

jobIds

Array of strings

仕事ID

addressIds

Array of strings

現場ID

clientIds

Array of strings

顧客ID

slug

string or null

仕事日程の管理番号

object

仕事日程の作成日範囲

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

仕事日程の更新日範囲

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

isArchive

boolean or null

アーカイブフラグによるフィルタ trueの場合アーカイブ済みの仕事日程のみ、falseの場合非アーカイブの仕事日程のみ、未指定の場合は全件取得

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalAppointment)

仕事情報の配列

Array

id

required

string

仕事日程ID

externalId

string or null

外部ID

jobId

required

string

仕事ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isArchive

required

boolean

アーカイブフラグ trueの場合は仕事日程がアーカイブされている

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"ids": ["string"
],
"externalIds": ["string"
],
"jobIds": ["string"
],
"addressIds": ["string"
],
"clientIds": ["string"
],
"slug": "2024-02-003-A01",
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"updatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"isArchive": false
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "cl5c0bcz318351015l39r39wao",
"jobId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isArchive": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
]
}

仕事日程を作成または更新

仕事日程を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id

string or null

仕事日程ID

externalId

string or null

外部ID

startTime

string or null <date-time>

仕事日程開始日時

endTime

string or null <date-time>

仕事日程終了日時

acceptedAt

string or null <date-time>

検収日

title

string or null

仕事日程タイトル

allDay

boolean or null

Default: false

終日フラグ trueの場合は終日の仕事とみなす

isFixed

boolean or null

Default: true

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

boolean or null

Default: true

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

object

会社情報

externalId	string or null 外部ID
id	string or null 会社ID

object

仕事情報

externalId	string or null 外部ID
id	string or null 仕事ID

object

到着時間帯情報

externalId	string or null 外部ID
id	string or null 到着時間帯ID

Array of objects (AssignmentForExternalUpsertAppointment)

アサインするユーザー情報

Array

externalId	string or null 外部ID
id	string or null ユーザーID

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

仕事日程の詳細情報

id

required

string

仕事日程ID

externalId

string or null

外部ID

jobId

required

string

仕事ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isArchive

required

boolean

アーカイブフラグ trueの場合は仕事日程がアーカイブされている

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"title": "作業当日",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"company": {"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
},
"job": {"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
},
"arrivalWindow": {"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
},
"assignments": [{"externalId": "string",
"id": "clnyjk3fj00ut5s012looknz7"
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl5c0bcz318351015l39r39wao",
"externalId": "cl5c0bcz318351015l39r39wao",
"jobId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isArchive": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
}

仕事日程を更新（外部ID）

外部IDで仕事日程を指定して更新するためのAPIです。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: ext-appointment-12345

仕事日程の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

externalId

string or null

外部ID

startTime

string <date-time>

仕事日程開始日時

endTime

string <date-time>

仕事日程終了日時

acceptedAt

string or null <date-time>

検収日

title

string or null

仕事日程タイトル

allDay

boolean

終日フラグ。trueの場合は終日の仕事とみなす

isFixed

boolean

仕事日程が確定しているかどうかのフラグ

isStartDateFixed

boolean

仕事日程の開始日付が確定しているかどうかのフラグ

object

仕事参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

到着時間帯参照。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

アサインするユーザー参照

Array

id	string プロワンが発行したID
externalId	string 外部ID

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

仕事日程の詳細情報

id

required

string

仕事日程ID

externalId

string or null

外部ID

jobId

required

string

仕事ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

管理番号

title

string or null

仕事日程タイトル

startTime

required

string <date-time>

仕事日程開始日時

endTime

required

string <date-time>

仕事日程終了日時

finishedAt

string or null <date-time>

仕事日程完了日

dispatchedAt

string or null <date-time>

出発日時

arrivedAt

string or null <date-time>

到着日時

acceptedAt

string or null <date-time>

検収日

allDay

required

boolean

終日フラグ trueの場合は終日の仕事とみなす

isArchive

required

boolean

アーカイブフラグ trueの場合は仕事日程がアーカイブされている

isFixed

required

boolean

仕事日程が確定しているかどうかのフラグ trueの場合は仕事日程が確定している

isStartDateFixed

required

boolean

仕事日程の開始日付が確定しているかどうかのフラグ trueの場合は仕事日程の開始日時が確定している

duration

number or null

所要時間

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

object or null

到着時間帯情報

id required	string 到着時間帯ID
name required	string 到着時間帯名
startTime required	string <date-time> 開始時間（時間のみ利用）
endTime required	string <date-time> 終了時間（時間のみ利用）

required

Array of objects (AssignmentForExternalJob)

訪問担当者情報

Array

required

object

ユーザー情報

id required	string ユーザーID
lastname required	string 姓
firstname	string or null 名
image	string or null ユーザーのアイコン画像のURL
externalId	string or null 外部ID

Request samples

Payload

Content type

application/json

{"externalId": "ext-appointment-12345",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"title": "作業当日",
"allDay": false,
"isFixed": true,
"isStartDateFixed": true,
"job": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"arrivalWindow": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"assignments": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl5c0bcz318351015l39r39wao",
"externalId": "cl5c0bcz318351015l39r39wao",
"jobId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"slug": "2024-02-003-A01",
"title": "作業当日",
"startTime": "2023-05-01T09:00:00.000Z",
"endTime": "2023-05-01T18:00:00.000Z",
"finishedAt": "2023-05-01T17:00:00.000Z",
"dispatchedAt": "2023-05-01T08:00:00.000Z",
"arrivedAt": "2023-05-01T08:30:00.000Z",
"acceptedAt": "2023-05-01T00:00:00.000Z",
"allDay": false,
"isArchive": false,
"isFixed": true,
"isStartDateFixed": true,
"duration": 480,
"customFields": {"property1": "string",
"property2": "string"
},
"arrivalWindow": {"id": "clnyjk3fj00ut5s012looknz7",
"name": "午後イチ",
"startTime": "2000-01-01T06:00:00.000Z",
"endTime": "2000-01-01T07:45:00.000Z"
},
"assignments": [{"user": {"id": "ckz21yyek2147015jhdem6o0h",
"lastname": "斉藤",
"firstname": "次郎",
"image": "https://example.com/user/profile.png",
"externalId": "clsl932010000u9r2h8bkbe00"
}
}
]
}
}

カスタム帳票

カスタム帳票の詳細を取得

カスタム帳票の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: clptk0yf302315o01wq9zbo6g

カスタム帳票ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

カスタム帳票詳細情報

id

required

string

カスタム帳票ID

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

jobId

required

string

仕事ID

title

required

string

タイトル

issuedAt

string or null <date-time>

見積書発行日

note

string or null

備考

taxType

string or null

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

消費税

税込 TaxIncluded
税抜 TaxExcluded
税込（免税） TaxExempted

document

object or null

書類

documentTemplateId

string or null

書類レイアウトID

isArchive

boolean or null

アーカイブフラグ

slug

string or null

見積書番号

effectiveDuration

string or null

有効期限

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalCustomDocumentLine)

カスタム帳票明細行情報の配列

Array

id

required

string

ID

label

required

string

アイテム名

keyPath

required

string

ドット区切りのパス

sortNum

required

number

並び順

isTextLine

required

boolean

テキスト行フラグ

group

required

string

書類明細タイプ識別子

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

object

Deprecated

note	string or null Default: null
internalNote	string or null Default: null
taxCode	string or null Default: null
priceBookItemId	string or null Default: null
modelName	string or null Default: null
quantity	stringd+(.d+)?
unitName	string or null Default: null
unitCost	string or nulld+(.d+)? Default: null
unitPrice	stringd+(.d+)?
unitListPrice	string or nulld+(.d+)? Default: null
unitListPriceString	string or null Default: null
discountPrice	string or nulld+(.d+)? Default: null
billedAmount	string or nulld+(.d+)? Default: null
deliveryTime	string or null <date-time> Default: null
originalUnitCost	string or nulld+(.d+)? Default: null
originalUnitPrice	string or nulld+(.d+)? Default: null

note

string or null

Default: null

flattened fields: fields the deleted and deprecated officialFields

internalNote

string or null

Default: null

taxCode

string or null

Default: null

priceBookItemId

string or null

Default: null

modelName

string or null

Default: null

quantity

required

stringd+(.d+)?

unitName

string or null

Default: null

unitCost

string or nulld+(.d+)?

Default: null

unitPrice

required

stringd+(.d+)?

unitListPrice

string or nulld+(.d+)?

Default: null

unitListPriceString

string or null

Default: null

discountPrice

string or nulld+(.d+)?

Default: null

billedAmount

string or nulld+(.d+)?

Default: null

deliveryTime

string or null <date-time>

Default: null

originalUnitCost

string or nulld+(.d+)?

Default: null

originalUnitPrice

string or nulld+(.d+)?

Default: null

manufacturerId

string or null

end: flattened fields

object

価格表アイテムメーカー情報

name

required

string

メーカー名

Response samples

Content type

application/json

{"data": {"id": "cm3idfnja000bt1bx7s370h1w",
"createdAt": "2024-11-15T00:00:00.000Z",
"updatedAt": "2024-11-21T00:00:00.000Z",
"jobId": "cm3762m6400005yuc1vgqaewu",
"title": "",
"issuedAt": "2024-11-31T00:00:00.000Z",
"note": "特になし",
"taxType": "TaxIncluded",
"document": { },
"documentTemplateId": "cm3idbtg10006t1bxw0pznc30",
"isArchive": false,
"slug": "2024-11-003-E01",
"effectiveDuration": "発行日から30日間",
"customFields": {"property1": "string",
"property2": "string"
},
"customDocumentLines": [{"id": "cm3idfnja000bt1bx7s370h1w",
"label": "清掃代",
"keyPath": "594ed7ec-a517-472e-aa8c-7997b7c92629",
"sortNum": 1,
"isTextLine": false,
"group": "cm3e9ohtl00041htbrilsfp46",
"customFields": {"property1": "string",
"property2": "string"
},
"officialFields": {"note": null,
"internalNote": null,
"taxCode": null,
"priceBookItemId": null,
"modelName": null,
"quantity": "string",
"unitName": null,
"unitCost": null,
"unitPrice": "string",
"unitListPrice": null,
"unitListPriceString": null,
"discountPrice": null,
"billedAmount": null,
"deliveryTime": null,
"originalUnitCost": null,
"originalUnitPrice": null
},
"note": null,
"internalNote": null,
"taxCode": null,
"priceBookItemId": null,
"modelName": null,
"quantity": "string",
"unitName": null,
"unitCost": null,
"unitPrice": "string",
"unitListPrice": null,
"unitListPriceString": null,
"discountPrice": null,
"billedAmount": null,
"deliveryTime": null,
"originalUnitCost": null,
"originalUnitPrice": null,
"manufacturerId": "string",
"manufacturer": "cm3idfnja000ct1bxx3mypuvi"
}
]
}
}

発注先

発注先を作成または更新

発注先を作成または更新するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id

string or null

発注先ID

externalId

string or null

外部ID

companyName

string or null

企業名

compellation

string or null

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

object (DivisionForExternalUpsertSeller)

externalId	string or null 外部ID
id	string or null 部署ID

object or null

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

発注先の詳細情報

id

required

string

発注先ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

companyName

required

string

企業名

compellation

string or null

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

divisionId

string or null

部署ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

boolean or null

アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "string",
"companyName": "山田電気株式会社",
"compellation": "様",
"email": "string",
"fax": "string",
"phone": "string",
"zipcode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"cutoffDateCode": "99",
"paymentDateCode": "216",
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"companyName": "山田電気株式会社",
"compellation": "様",
"email": "string",
"fax": "string",
"phone": "string",
"zipcode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"cutoffDateCode": "99",
"paymentDateCode": "216",
"divisionId": "cm5lvz29a000bhe57qseo2ush",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false
}
}

発注先を更新（ID）

IDで発注先を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

id

required

string

Example: cl3l7lqsj3303015nraag2rho

発注先ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

companyName

string or null

企業名

compellation

string or null

Enum: "様" "御中" "殿"

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

object

部署情報。:externalId, :idのいずれか1つを指定。

externalId	string or null 外部ID
id	string or null 部署ID

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

発注先の詳細情報

id

required

string

発注先ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

companyName

required

string

企業名

compellation

string or null

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

divisionId

string or null

部署ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

boolean or null

アーカイブフラグ

Request samples

Payload

Content type

application/json

{"companyName": "山田電気株式会社",
"compellation": "様",
"email": "info@example.com",
"fax": "03-1234-5679",
"phone": "03-1234-5678",
"zipcode": "100-0001",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"cutoffDateCode": 99,
"paymentDateCode": 216,
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"companyName": "山田電気株式会社",
"compellation": "様",
"email": "string",
"fax": "string",
"phone": "string",
"zipcode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"cutoffDateCode": "99",
"paymentDateCode": "216",
"divisionId": "cm5lvz29a000bhe57qseo2ush",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false
}
}

発注先を更新（外部ID）

外部ID（externalId）で発注先を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: seller-123

発注先の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

companyName

string or null

企業名

compellation

string or null

Enum: "様" "御中" "殿"

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

object

部署情報。:externalId, :idのいずれか1つを指定。

externalId	string or null 外部ID
id	string or null 部署ID

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object

発注先の詳細情報

id

required

string

発注先ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

companyName

required

string

企業名

compellation

string or null

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

divisionId

string or null

部署ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

boolean or null

アーカイブフラグ

Request samples

Payload

Content type

application/json

{"companyName": "山田電気株式会社",
"compellation": "様",
"email": "info@example.com",
"fax": "03-1234-5679",
"phone": "03-1234-5678",
"zipcode": "100-0001",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"cutoffDateCode": 99,
"paymentDateCode": 216,
"division": {"externalId": "string",
"id": "clhhayfgu0003015kcsx0hvid"
},
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"companyName": "山田電気株式会社",
"compellation": "様",
"email": "string",
"fax": "string",
"phone": "string",
"zipcode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"cutoffDateCode": "99",
"paymentDateCode": "216",
"divisionId": "cm5lvz29a000bhe57qseo2ush",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false
}
}

発注先一覧を取得

発注先の一覧データを絞り込み条件やソート、ページネーションで取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

sort

string or null

Enum: "id" "externalId" "companyName" "createdAt" "updatedAt" "cutoffDateCode" "paymentDateCode"

ソートフィールド

order

string or null

Enum: "asc" "desc"

ソート順序

ids

Array of strings

発注先IDの配列でフィルタ

externalIds

Array of strings

外部IDの配列でフィルタ

companyName

string or null

企業名で部分一致検索

object

作成日の範囲フィルタ

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

更新日の範囲フィルタ

start	string or null <date-time> 更新日の範囲開始日時
end	string or null <date-time> 更新日の範囲終了日時

isArchive

boolean or null

アーカイブフラグによるフィルタ trueの場合アーカイブ済みの発注先のみ、falseの場合非アーカイブの発注先のみ、未指定の場合は全件取得 nullを指定した場合はバリデーションエラーとなります

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalSeller)

発注先情報の配列

Array

id

required

string

発注先ID

externalId

string or null

外部ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

companyName

required

string

企業名

compellation

string or null

敬称

email

string or null

メールアドレス

fax

string or null

FAX番号

phone

string or null

電話番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

番地

address2

string or null

建物・部屋番号

cutoffDateCode

number or null

締め日

paymentDateCode

number or null

支払日

divisionId

string or null

部署ID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

isArchive

boolean or null

アーカイブフラグ

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"sort": "companyName",
"order": "asc",
"ids": ["id1",
"id2"
],
"externalIds": ["ext1",
"ext2"
],
"companyName": "株式会社",
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"updatedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"isArchive": false
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "string",
"createdAt": "2021-08-01T00:00:00.000Z",
"updatedAt": "2021-08-01T00:00:00.000Z",
"companyName": "山田電気株式会社",
"compellation": "様",
"email": "string",
"fax": "string",
"phone": "string",
"zipcode": "string",
"state": "string",
"city": "string",
"address1": "string",
"address2": "string",
"cutoffDateCode": "99",
"paymentDateCode": "216",
"divisionId": "cm5lvz29a000bhe57qseo2ush",
"customFields": {"property1": "string",
"property2": "string"
},
"isArchive": false
}
]
}

発注先をアーカイブ

発注先をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 発注先ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 発注先ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

発注先のアーカイブを解除

リクエストしたID/外部IDで対象の1件の発注先のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 発注先ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 発注先ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブ状態

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

発注先担当者

発注先担当者を作成

発注先担当者を新規作成するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

発注先（idまたはexternalIdのいずれかを指定）。:id, :externalIdのいずれか1つを指定。

id	string プロワンが発行したID
externalId	string 外部ID

lastname

required

string

担当者姓

firstname

string or null

担当者名

lastnameKana

string or null

担当者姓（カナ）

firstnameKana

string or null

担当者名（カナ）

phone

string or null

電話番号

email

string or null

メールアドレス

internalNote

string or null

社内メモ

externalId

string or null

外部ID

Responses

Response Schema: application/json

required

object

発注先担当者の詳細情報

id required	string 発注先担当者ID
externalId	string or null 外部ID
sellerId required	string 発注先ID
lastname required	string 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
isArchive required	boolean アーカイブフラグ
createdAt required	string <date-time> 作成日時
updatedAt required	string <date-time> 更新日時

Request samples

Payload

Content type

application/json

{"seller": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"externalId": "ext-contact-12345"
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "ext-contact-12345",
"sellerId": "cm5lvz29a000bhe57qseo2ush",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"isArchive": false,
"createdAt": "2017-12-08T00:00:00.000Z",
"updatedAt": "2017-12-08T00:00:00.000Z"
}
}

発注先担当者の詳細を取得（ID）

IDで発注先担当者の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cm5lvz5q50132he57wdc1gbmx

発注先担当者ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

発注先担当者の詳細情報

id required	string 発注先担当者ID
externalId	string or null 外部ID
sellerId required	string 発注先ID
lastname required	string 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
isArchive required	boolean アーカイブフラグ
createdAt required	string <date-time> 作成日時
updatedAt required	string <date-time> 更新日時

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "ext-contact-12345",
"sellerId": "cm5lvz29a000bhe57qseo2ush",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"isArchive": false,
"createdAt": "2017-12-08T00:00:00.000Z",
"updatedAt": "2017-12-08T00:00:00.000Z"
}
}

発注先担当者を更新（ID）

IDで発注先担当者を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

id

required

string

Example: cm5lvz5q50132he57wdc1gbmx

発注先担当者ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

lastname	string or null 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
externalId	string or null 外部ID

Responses

Response Schema: application/json

required

object

発注先担当者の詳細情報

id required	string 発注先担当者ID
externalId	string or null 外部ID
sellerId required	string 発注先ID
lastname required	string 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
isArchive required	boolean アーカイブフラグ
createdAt required	string <date-time> 作成日時
updatedAt required	string <date-time> 更新日時

Request samples

Payload

Content type

application/json

{"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"externalId": "ext-contact-12345"
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "ext-contact-12345",
"sellerId": "cm5lvz29a000bhe57qseo2ush",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"isArchive": false,
"createdAt": "2017-12-08T00:00:00.000Z",
"updatedAt": "2017-12-08T00:00:00.000Z"
}
}

発注先担当者の詳細を取得（外部ID）

外部ID（externalId）で発注先担当者の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: ext-contact-12345

発注先担当者の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object

発注先担当者の詳細情報

id required	string 発注先担当者ID
externalId	string or null 外部ID
sellerId required	string 発注先ID
lastname required	string 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
isArchive required	boolean アーカイブフラグ
createdAt required	string <date-time> 作成日時
updatedAt required	string <date-time> 更新日時

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "ext-contact-12345",
"sellerId": "cm5lvz29a000bhe57qseo2ush",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"isArchive": false,
"createdAt": "2017-12-08T00:00:00.000Z",
"updatedAt": "2017-12-08T00:00:00.000Z"
}
}

発注先担当者を更新（外部ID）

外部ID（externalId）で発注先担当者を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: ext-contact-12345

発注先担当者の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

lastname	string or null 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
externalId	string or null 外部ID

Responses

Response Schema: application/json

required

object

発注先担当者の詳細情報

id required	string 発注先担当者ID
externalId	string or null 外部ID
sellerId required	string 発注先ID
lastname required	string 担当者姓
firstname	string or null 担当者名
lastnameKana	string or null 担当者姓（カナ）
firstnameKana	string or null 担当者名（カナ）
phone	string or null 電話番号
email	string or null メールアドレス
internalNote	string or null 社内メモ
isArchive required	boolean アーカイブフラグ
createdAt required	string <date-time> 作成日時
updatedAt required	string <date-time> 更新日時

Request samples

Payload

Content type

application/json

{"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"externalId": "ext-contact-12345"
}

Response samples

Content type

application/json

{"data": {"id": "cm5lvz5q50132he57wdc1gbmx",
"externalId": "ext-contact-12345",
"sellerId": "cm5lvz29a000bhe57qseo2ush",
"lastname": "山田",
"firstname": "太郎",
"lastnameKana": "ヤマダ",
"firstnameKana": "タロウ",
"phone": "03-1234-5678",
"email": "yamada@example.com",
"internalNote": "月末締め対応",
"isArchive": false,
"createdAt": "2017-12-08T00:00:00.000Z",
"updatedAt": "2017-12-08T00:00:00.000Z"
}
}

発注先担当者をアーカイブ

リクエストしたID/外部IDで対象の1件の発注先担当者をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 発注先担当者ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 発注先担当者ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

発注先担当者のアーカイブを解除

リクエストしたID/外部IDで対象の1件の発注先担当者のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 発注先担当者ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 発注先担当者ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "string"
}

Response samples

Content type

application/json

{"id": "string",
"externalId": "string",
"isArchive": true
}

ユーザー

ユーザー一覧を取得

テナントのユーザー一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage	number or null Default: 10 1ページあたりの件数（最大50）
page	number or null Default: 1 ページ番号
ids	Array of strings or null ユーザーIDの配列（完全一致）
externalIds	Array of strings or null 外部IDの配列（完全一致）
lastname	string or null 姓（部分一致）
firstname	string or null 名（部分一致）
isArchive	boolean or null アーカイブユーザーを含めるか（未指定時はアクティブのみ）
divisionIds	Array of strings or null 部署IDの配列
isTechnician	boolean or null 訪問担当者のみを取得するかどうか

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (UserForExternalUserFindAllResponse)

ユーザー情報の配列

Array

id required	string ユーザーID
email required	string <email> メールアドレス
phone	string or null 電話番号
lastname required	string 姓
firstname	string or null 名
isTechnician required	boolean 訪問担当者フラグ。trueの場合現場アプリが利用可能になる
divisionId required	string 部署ID
image	string or null ユーザーのアイコン画像のURL
isArchive required	boolean アーカイブフラグ。trueの場合ログインできない
externalId	string or null 外部連携ID

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"ids": ["clqc7ub2i048l5l01kps84bn4"
],
"externalIds": ["EXTERNAL-USER-0001"
],
"lastname": "山田",
"firstname": "太郎",
"isArchive": true,
"divisionIds": ["clpv02z6a002r5j013zfa9f9g",
"clpv02z6a002r5j013zfa9f9h"
],
"isTechnician": true
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "clqc7ub2i048l5l01kps84bn4",
"email": "sample@meetsmore.com",
"phone": "09012345678",
"lastname": "山田",
"firstname": "太郎",
"isTechnician": true,
"divisionId": "clqc7ub2i048l5l01kps84bn4",
"image": "https://example.com/sample.png",
"isArchive": true,
"externalId": "EXTERNAL-USER-0001"
}
]
}

発注書

発注書一覧を取得

テナントの発注書一覧を取得するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

perPage

number or null

Default: 10

1ページあたりの件数（最大50）

page

number or null

Default: 1

ページ番号

ids

Array of strings

発注書IDの配列（完全一致）

externalIds

Array of strings

外部IDの配列（完全一致）

slug

Array of strings

発注番号の配列（完全一致）

title

string or null

発注書名（部分一致）

isArchive

boolean or null

アーカイブフラグによるフィルタ

Array of objects (IdOrExternalIdReferenceDto)

仕事の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

発注先の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

担当者の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

部署の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Array of objects (IdOrExternalIdReferenceDto)

受取人の配列（idまたはexternalIdで指定）

Array

id	string プロワンが発行したID
externalId	string 外部ID

object

発注日の範囲フィルタ

start	string or null <date-time> 発行日の範囲開始日時
end	string or null <date-time> 発行日の範囲終了日時

object

納品日の範囲フィルタ

start	string or null <date-time> 納品日の範囲開始日時
end	string or null <date-time> 納品日の範囲終了日時

object

作成日の範囲フィルタ

start	string or null <date-time> 作成日の範囲開始日時
end	string or null <date-time> 作成日の範囲終了日時

object

支払日の範囲フィルタ

start	string or null <date-time> 支払日の範囲開始日時
end	string or null <date-time> 支払日の範囲終了日時

object

納期の範囲フィルタ

start	string or null <date-time> 納期の範囲開始日時
end	string or null <date-time> 納期の範囲終了日時

Responses

Response Schema: application/json

total

required

number

トータル件数

required

Array of objects (ExternalPurchaseOrderForFindAll)

発注書情報の配列

Array

id

required

string

発注書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

発注番号

title

string or null

発注書名

type

required

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

issuedAt

string or null <date-time>

発注日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string or null <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額

note

string or null

備考

deliveryAddress

string (DeliveryAddressType)

Enum: "CompanyAddress" "SiteAddress"

配送先区分

deliveryTime

string or null <date-time>

発注書単位の納期

billingDate

string or null <date-time>

被請求日

paymentDueDate

string or null <date-time>

支払期日

externalId

string or null

外部ID

isArchive

required

boolean

アーカイブフラグ

object or null

仕事

id required	string 仕事ID
externalId	string or null 仕事外部ID

required

object

発注先

id

required

string

発注先ID

externalId

string or null

発注先外部ID

isArchive

required

boolean

required

Array of objects (ExternalSellerContactForPurchaseOrder)

Array

id required	string 発注先担当者ID
isArchive required	boolean

required

object

担当者

id required	string 担当者ID
externalId	string or null 担当者外部ID
isArchive required	boolean

object or null

受取人

id required	string 受取人ID
externalId	string or null 受取人外部ID
isArchive required	boolean

required

Array of objects (ExternalTagForPurchaseOrder)

タグ

Array

id required	string タグID
name required	string タグ名
color required	string タグの色

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalPurchaseOrderLineForFindAll)

書類行

Array

id

required

string

プロワンが発行した明細行ID

label

required

string

書類行アイテム名

unitPrice

string or null^-?\d+(\.\d+)?$

書類行単価

quantity

string or null^-?\d+(\.\d+)?$

書類行数量

unitName

string or null

単位

modelName

string or null

型番

deliveryTime

string or null

書類行納期

priceBookItemId

string or null

ID

note

string or null

書類備考

keyPath

required

string

階層構造をUUID v4の . 区切りで表現した値

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveredAt

string or null <date-time>

書類行納品日

billingDate

string or null <date-time>

書類行被請求日

paymentDueDate

string or null <date-time>

書類行支払期日

sortNum

number or null

isTextLine

required

boolean

manufacturerId

string or null

メーカー

purchaseOrderLinesCount

required

number

明細行の件数

Request samples

Payload

Content type

application/json

{"perPage": 50,
"page": 1,
"ids": ["cl3l7lqsj3303015nraag2rho"
],
"externalIds": ["ext_purchase_order_12345"
],
"slug": ["PO-2025-0001"
],
"title": "〇〇様向け",
"isArchive": false,
"job": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"seller": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"user": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"division": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"recipient": [{"id": "cl3l7lqsj3303015nraag2rho"
}
],
"issuedAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"deliveredAt": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"createdAt": {"start": "2020-11-30T15%3A00%3A00.000Z",
"end": "2020-11-31T15%3A00%3A00.000Z"
},
"paidAt": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
},
"deliveryTime": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z"
}
}

Response samples

Content type

application/json

{"total": 1,
"data": [{"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"slug": "PO-2025-0001",
"title": "〇〇様向け発注書",
"type": "JOB",
"taxType": "TaxExcluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"issuedAt": "2025-01-01T00:00:00.000Z",
"receivedAt": "2025-01-05T00:00:00.000Z",
"deliveredAt": "2025-01-10T00:00:00.000Z",
"paidAt": "2025-01-15T00:00:00.000Z",
"partiallyPaidAt": "2025-01-12T00:00:00.000Z",
"paidAmount": "50000",
"note": "至急手配お願いします",
"deliveryAddress": "CompanyAddress",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"billingDate": "2025-02-01T00:00:00.000Z",
"paymentDueDate": "2025-02-28T00:00:00.000Z",
"externalId": "ext_purchase_order_12345",
"isArchive": false,
"job": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-job-12345"
},
"seller": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-seller-12345",
"isArchive": true,
"sellerContacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"isArchive": true
}
]
},
"user": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"recipient": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"tags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "緊急",
"color": "#FF0000"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"id": "cl3l7lqsj3303015nraag2rho",
"label": "配管材料一式",
"unitPrice": "1000",
"quantity": "2",
"unitName": "式",
"modelName": "ABC-123",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"priceBookItemId": "pb_item_12345",
"note": "至急手配お願いします",
"keyPath": "a4b54201-b64c-4d97-8abb-5581ffb68496.9a70feab-5a56-48f6-a47f-e892c6739d84",
"customFields": {"property1": "string",
"property2": "string"
},
"deliveredAt": "2025-02-01T00:00:00.000Z",
"billingDate": "2025-02-05T00:00:00.000Z",
"paymentDueDate": "2025-02-29T00:00:00.000Z",
"sortNum": 0,
"isTextLine": true,
"manufacturerId": "cl3l7lqsj3303015nraag2rho"
}
],
"purchaseOrderLinesCount": 5
}
]
}

発注書の詳細を取得

IDで発注書の詳細データを取得するAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cxp13i0x00945w01t57rk37i

発注書ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object (ExternalPurchaseOrderFull)

id

required

string

発注書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

発注番号

title

string or null

発注書名

type

required

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

issuedAt

string or null <date-time>

発注日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string or null <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額

note

string or null

備考

deliveryAddress

string (DeliveryAddressType)

Enum: "CompanyAddress" "SiteAddress"

配送先区分

deliveryTime

string or null <date-time>

発注書単位の納期

billingDate

string or null <date-time>

被請求日

paymentDueDate

string or null <date-time>

支払期日

externalId

string or null

外部ID

isArchive

required

boolean

アーカイブフラグ

object or null

仕事

id required	string 仕事ID
externalId	string or null 仕事外部ID

required

object

発注先

id

required

string

発注先ID

externalId

string or null

発注先外部ID

isArchive

required

boolean

required

Array of objects (ExternalSellerContactForPurchaseOrder)

Array

id required	string 発注先担当者ID
isArchive required	boolean

required

object

担当者

id required	string 担当者ID
externalId	string or null 担当者外部ID
isArchive required	boolean

object or null

受取人

id required	string 受取人ID
externalId	string or null 受取人外部ID
isArchive required	boolean

required

Array of objects (ExternalTagForPurchaseOrder)

タグ

Array

id required	string タグID
name required	string タグ名
color required	string タグの色

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalPurchaseOrderLineForFindOne)

書類行

Array

id

required

string

プロワンが発行した明細行ID

label

required

string

書類行アイテム名

unitPrice

string or null^-?\d+(\.\d+)?$

書類行単価

quantity

string or null^-?\d+(\.\d+)?$

書類行数量

unitName

string or null

単位

modelName

string or null

型番

deliveryTime

string or null

書類行納期

priceBookItemId

string or null

ID

note

string or null

書類備考

keyPath

required

string

階層構造をUUID v4の . 区切りで表現した値

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveredAt

string or null <date-time>

書類行納品日

billingDate

string or null <date-time>

書類行被請求日

paymentDueDate

string or null <date-time>

書類行支払期日

sortNum

number or null

isTextLine

required

boolean

manufacturerId

string or null

メーカー

object or null

id

required

string

メーカー

Array of objects (ExternalPaymentEntity)

支払い履歴

Array

id required	string 支払い履歴ID
createdAt required	string <date-time> 支払い履歴登録日
updatedAt required	string <date-time> 支払い履歴更新日
date required	string <date-time> 支払い履歴実入金日
amount required	string^-?\d+(\.\d+)?$ 支払い履歴実入金額
notes	string or null 支払い履歴社内メモ

object or null

現在の版

id

required

string

版ID

documentHistoryId

string or null

版ID

hasBeenIssuedBefore

required

boolean

発行履歴あり

latestApprovalRequestDraft

object or null

承認申請下書き

latestApprovalRequest

object or null

承認申請

required

object

承認申請設定

id required	string 承認申請設定ID
isRequired required	boolean
isArchive required	boolean

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"slug": "PO-2025-0001",
"title": "〇〇様向け発注書",
"type": "JOB",
"taxType": "TaxExcluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"issuedAt": "2025-01-01T00:00:00.000Z",
"receivedAt": "2025-01-05T00:00:00.000Z",
"deliveredAt": "2025-01-10T00:00:00.000Z",
"paidAt": "2025-01-15T00:00:00.000Z",
"partiallyPaidAt": "2025-01-12T00:00:00.000Z",
"paidAmount": "50000",
"note": "至急手配お願いします",
"deliveryAddress": "CompanyAddress",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"billingDate": "2025-02-01T00:00:00.000Z",
"paymentDueDate": "2025-02-28T00:00:00.000Z",
"externalId": "ext_purchase_order_12345",
"isArchive": false,
"job": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-job-12345"
},
"seller": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-seller-12345",
"isArchive": true,
"sellerContacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"isArchive": true
}
]
},
"user": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"recipient": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"tags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "緊急",
"color": "#FF0000"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"id": "cl3l7lqsj3303015nraag2rho",
"label": "配管材料一式",
"unitPrice": "1000",
"quantity": "2",
"unitName": "式",
"modelName": "ABC-123",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"priceBookItemId": "pb_item_12345",
"note": "至急手配お願いします",
"keyPath": "a4b54201-b64c-4d97-8abb-5581ffb68496.9a70feab-5a56-48f6-a47f-e892c6739d84",
"customFields": {"property1": "string",
"property2": "string"
},
"deliveredAt": "2025-02-01T00:00:00.000Z",
"billingDate": "2025-02-05T00:00:00.000Z",
"paymentDueDate": "2025-02-29T00:00:00.000Z",
"sortNum": 0,
"isTextLine": true,
"manufacturerId": "cl3l7lqsj3303015nraag2rho",
"manufacturer": {"id": "cl3l7lqsj3303015nraag2rho"
}
}
],
"payments": [{"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-10T00:00:00.000Z",
"updatedAt": "2025-01-10T00:00:00.000Z",
"date": "2025-01-10T00:00:00.000Z",
"amount": "50000",
"notes": "前払分"
}
],
"latestDocumentHistory": {"id": "cl3l7lqsj3303015nraag2rho"
},
"documentHistoryId": "cl3l7lqsj3303015nraag2rho",
"hasBeenIssuedBefore": true,
"latestApprovalRequestDraft": { },
"latestApprovalRequest": { },
"approvalRequestSetting": {"id": "cl3l7lqsj3303015nraag2rho",
"isRequired": true,
"isArchive": true
}
}
}

発注書の詳細を取得（externalId）

外部ID（externalId）で発注書の詳細データを取得するAPIです。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: ext_po_12345

発注書の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object (ExternalPurchaseOrderFull)

id

required

string

発注書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

発注番号

title

string or null

発注書名

type

required

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

issuedAt

string or null <date-time>

発注日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string or null <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額

note

string or null

備考

deliveryAddress

string (DeliveryAddressType)

Enum: "CompanyAddress" "SiteAddress"

配送先区分

deliveryTime

string or null <date-time>

発注書単位の納期

billingDate

string or null <date-time>

被請求日

paymentDueDate

string or null <date-time>

支払期日

externalId

string or null

外部ID

isArchive

required

boolean

アーカイブフラグ

object or null

仕事

id required	string 仕事ID
externalId	string or null 仕事外部ID

required

object

発注先

id

required

string

発注先ID

externalId

string or null

発注先外部ID

isArchive

required

boolean

required

Array of objects (ExternalSellerContactForPurchaseOrder)

Array

id required	string 発注先担当者ID
isArchive required	boolean

required

object

担当者

id required	string 担当者ID
externalId	string or null 担当者外部ID
isArchive required	boolean

object or null

受取人

id required	string 受取人ID
externalId	string or null 受取人外部ID
isArchive required	boolean

required

Array of objects (ExternalTagForPurchaseOrder)

タグ

Array

id required	string タグID
name required	string タグ名
color required	string タグの色

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalPurchaseOrderLineForFindOne)

書類行

Array

id

required

string

プロワンが発行した明細行ID

label

required

string

書類行アイテム名

unitPrice

string or null^-?\d+(\.\d+)?$

書類行単価

quantity

string or null^-?\d+(\.\d+)?$

書類行数量

unitName

string or null

単位

modelName

string or null

型番

deliveryTime

string or null

書類行納期

priceBookItemId

string or null

ID

note

string or null

書類備考

keyPath

required

string

階層構造をUUID v4の . 区切りで表現した値

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveredAt

string or null <date-time>

書類行納品日

billingDate

string or null <date-time>

書類行被請求日

paymentDueDate

string or null <date-time>

書類行支払期日

sortNum

number or null

isTextLine

required

boolean

manufacturerId

string or null

メーカー

object or null

id

required

string

メーカー

Array of objects (ExternalPaymentEntity)

支払い履歴

Array

id required	string 支払い履歴ID
createdAt required	string <date-time> 支払い履歴登録日
updatedAt required	string <date-time> 支払い履歴更新日
date required	string <date-time> 支払い履歴実入金日
amount required	string^-?\d+(\.\d+)?$ 支払い履歴実入金額
notes	string or null 支払い履歴社内メモ

object or null

現在の版

id

required

string

版ID

documentHistoryId

string or null

版ID

hasBeenIssuedBefore

required

boolean

発行履歴あり

latestApprovalRequestDraft

object or null

承認申請下書き

latestApprovalRequest

object or null

承認申請

required

object

承認申請設定

id required	string 承認申請設定ID
isRequired required	boolean
isArchive required	boolean

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"slug": "PO-2025-0001",
"title": "〇〇様向け発注書",
"type": "JOB",
"taxType": "TaxExcluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"issuedAt": "2025-01-01T00:00:00.000Z",
"receivedAt": "2025-01-05T00:00:00.000Z",
"deliveredAt": "2025-01-10T00:00:00.000Z",
"paidAt": "2025-01-15T00:00:00.000Z",
"partiallyPaidAt": "2025-01-12T00:00:00.000Z",
"paidAmount": "50000",
"note": "至急手配お願いします",
"deliveryAddress": "CompanyAddress",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"billingDate": "2025-02-01T00:00:00.000Z",
"paymentDueDate": "2025-02-28T00:00:00.000Z",
"externalId": "ext_purchase_order_12345",
"isArchive": false,
"job": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-job-12345"
},
"seller": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-seller-12345",
"isArchive": true,
"sellerContacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"isArchive": true
}
]
},
"user": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"recipient": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"tags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "緊急",
"color": "#FF0000"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"id": "cl3l7lqsj3303015nraag2rho",
"label": "配管材料一式",
"unitPrice": "1000",
"quantity": "2",
"unitName": "式",
"modelName": "ABC-123",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"priceBookItemId": "pb_item_12345",
"note": "至急手配お願いします",
"keyPath": "a4b54201-b64c-4d97-8abb-5581ffb68496.9a70feab-5a56-48f6-a47f-e892c6739d84",
"customFields": {"property1": "string",
"property2": "string"
},
"deliveredAt": "2025-02-01T00:00:00.000Z",
"billingDate": "2025-02-05T00:00:00.000Z",
"paymentDueDate": "2025-02-29T00:00:00.000Z",
"sortNum": 0,
"isTextLine": true,
"manufacturerId": "cl3l7lqsj3303015nraag2rho",
"manufacturer": {"id": "cl3l7lqsj3303015nraag2rho"
}
}
],
"payments": [{"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-10T00:00:00.000Z",
"updatedAt": "2025-01-10T00:00:00.000Z",
"date": "2025-01-10T00:00:00.000Z",
"amount": "50000",
"notes": "前払分"
}
],
"latestDocumentHistory": {"id": "cl3l7lqsj3303015nraag2rho"
},
"documentHistoryId": "cl3l7lqsj3303015nraag2rho",
"hasBeenIssuedBefore": true,
"latestApprovalRequestDraft": { },
"latestApprovalRequest": { },
"approvalRequestSetting": {"id": "cl3l7lqsj3303015nraag2rho",
"isRequired": true,
"isArchive": true
}
}
}

発注書を作成

発注書を新規作成するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

発注先。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

発注先担当者参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

作成ユーザ参照（省略時はサービスアカウントが自動割り当て）。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

仕事参照（JOBタイプの場合は必須、INVENTORYタイプの場合は省略可）。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

type

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

object

部署参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object

宛先ユーザ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

title

string or null

表題

issuedAt

string or null <date-time>

発行日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額（Decimal文字列または数値）

deliveryAddress

string or null

Enum: "CompanyAddress" "SiteAddress"

配送先区分

note

string or null

備考

internalNote

string or null

社内メモ

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

object

ドキュメントテンプレート参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

deliveryTime

string <date-time>

発注書単位の納期

required

Array of objects (ExternalCreatePurchaseOrderLineDto)

発注書明細（1行以上）

Array

label

required

string

品名

quantity

required

string^-?\d+(\.\d+)?$

数量

unitPrice

required

string^-?\d+(\.\d+)?$

単価

unitName

string or null

単位

modelName

string or null

型番

object

価格表アイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

note

string or null

明細備考

isTextLine

required

boolean

Default: false

テキスト行フラグ

object

メーカー名参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalCreatePurchaseOrderTagDto)

タグ（最大50件）

Array

name required	string タグ名
color required	string タグ色（HEX）

Responses

Response Schema: application/json

required

object (ExternalPurchaseOrderFull)

id

required

string

発注書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

発注番号

title

string or null

発注書名

type

required

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

issuedAt

string or null <date-time>

発注日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string or null <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額

note

string or null

備考

deliveryAddress

string (DeliveryAddressType)

Enum: "CompanyAddress" "SiteAddress"

配送先区分

deliveryTime

string or null <date-time>

発注書単位の納期

billingDate

string or null <date-time>

被請求日

paymentDueDate

string or null <date-time>

支払期日

externalId

string or null

外部ID

isArchive

required

boolean

アーカイブフラグ

object or null

仕事

id required	string 仕事ID
externalId	string or null 仕事外部ID

required

object

発注先

id

required

string

発注先ID

externalId

string or null

発注先外部ID

isArchive

required

boolean

required

Array of objects (ExternalSellerContactForPurchaseOrder)

Array

id required	string 発注先担当者ID
isArchive required	boolean

required

object

担当者

id required	string 担当者ID
externalId	string or null 担当者外部ID
isArchive required	boolean

object or null

受取人

id required	string 受取人ID
externalId	string or null 受取人外部ID
isArchive required	boolean

required

Array of objects (ExternalTagForPurchaseOrder)

タグ

Array

id required	string タグID
name required	string タグ名
color required	string タグの色

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalPurchaseOrderLineForFindOne)

書類行

Array

id

required

string

プロワンが発行した明細行ID

label

required

string

書類行アイテム名

unitPrice

string or null^-?\d+(\.\d+)?$

書類行単価

quantity

string or null^-?\d+(\.\d+)?$

書類行数量

unitName

string or null

単位

modelName

string or null

型番

deliveryTime

string or null

書類行納期

priceBookItemId

string or null

ID

note

string or null

書類備考

keyPath

required

string

階層構造をUUID v4の . 区切りで表現した値

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveredAt

string or null <date-time>

書類行納品日

billingDate

string or null <date-time>

書類行被請求日

paymentDueDate

string or null <date-time>

書類行支払期日

sortNum

number or null

isTextLine

required

boolean

manufacturerId

string or null

メーカー

object or null

id

required

string

メーカー

Array of objects (ExternalPaymentEntity)

支払い履歴

Array

id required	string 支払い履歴ID
createdAt required	string <date-time> 支払い履歴登録日
updatedAt required	string <date-time> 支払い履歴更新日
date required	string <date-time> 支払い履歴実入金日
amount required	string^-?\d+(\.\d+)?$ 支払い履歴実入金額
notes	string or null 支払い履歴社内メモ

object or null

現在の版

id

required

string

版ID

documentHistoryId

string or null

版ID

hasBeenIssuedBefore

required

boolean

発行履歴あり

latestApprovalRequestDraft

object or null

承認申請下書き

latestApprovalRequest

object or null

承認申請

required

object

承認申請設定

id required	string 承認申請設定ID
isRequired required	boolean
isArchive required	boolean

Request samples

Payload

Content type

application/json

{"seller": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"sellerContact": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"user": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"job": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"type": "JOB",
"division": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"recipient": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"title": "string",
"issuedAt": "2019-08-24T14:15:22Z",
"receivedAt": "2019-08-24T14:15:22Z",
"deliveredAt": "2019-08-24T14:15:22Z",
"paidAt": "2019-08-24T14:15:22Z",
"partiallyPaidAt": "2019-08-24T14:15:22Z",
"paidAmount": "0",
"deliveryAddress": "CompanyAddress",
"note": "string",
"internalNote": "string",
"taxType": "TaxIncluded",
"documentTemplate": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"deliveryTime": "2019-08-24T14:15:22Z",
"purchaseOrderLines": [{"label": "室外機",
"quantity": "1",
"unitPrice": "75000",
"unitName": "台",
"modelName": "R22LJXS",
"priceBookItem": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"note": "string",
"isTextLine": false,
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"customFields": {"property1": "string",
"property2": "string"
}
}
],
"tags": [{"name": "重要",
"color": "#RRGGBB"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"slug": "PO-2025-0001",
"title": "〇〇様向け発注書",
"type": "JOB",
"taxType": "TaxExcluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"issuedAt": "2025-01-01T00:00:00.000Z",
"receivedAt": "2025-01-05T00:00:00.000Z",
"deliveredAt": "2025-01-10T00:00:00.000Z",
"paidAt": "2025-01-15T00:00:00.000Z",
"partiallyPaidAt": "2025-01-12T00:00:00.000Z",
"paidAmount": "50000",
"note": "至急手配お願いします",
"deliveryAddress": "CompanyAddress",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"billingDate": "2025-02-01T00:00:00.000Z",
"paymentDueDate": "2025-02-28T00:00:00.000Z",
"externalId": "ext_purchase_order_12345",
"isArchive": false,
"job": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-job-12345"
},
"seller": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-seller-12345",
"isArchive": true,
"sellerContacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"isArchive": true
}
]
},
"user": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"recipient": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"tags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "緊急",
"color": "#FF0000"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"id": "cl3l7lqsj3303015nraag2rho",
"label": "配管材料一式",
"unitPrice": "1000",
"quantity": "2",
"unitName": "式",
"modelName": "ABC-123",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"priceBookItemId": "pb_item_12345",
"note": "至急手配お願いします",
"keyPath": "a4b54201-b64c-4d97-8abb-5581ffb68496.9a70feab-5a56-48f6-a47f-e892c6739d84",
"customFields": {"property1": "string",
"property2": "string"
},
"deliveredAt": "2025-02-01T00:00:00.000Z",
"billingDate": "2025-02-05T00:00:00.000Z",
"paymentDueDate": "2025-02-29T00:00:00.000Z",
"sortNum": 0,
"isTextLine": true,
"manufacturerId": "cl3l7lqsj3303015nraag2rho",
"manufacturer": {"id": "cl3l7lqsj3303015nraag2rho"
}
}
],
"payments": [{"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-10T00:00:00.000Z",
"updatedAt": "2025-01-10T00:00:00.000Z",
"date": "2025-01-10T00:00:00.000Z",
"amount": "50000",
"notes": "前払分"
}
],
"latestDocumentHistory": {"id": "cl3l7lqsj3303015nraag2rho"
},
"documentHistoryId": "cl3l7lqsj3303015nraag2rho",
"hasBeenIssuedBefore": true,
"latestApprovalRequestDraft": { },
"latestApprovalRequest": { },
"approvalRequestSetting": {"id": "cl3l7lqsj3303015nraag2rho",
"isRequired": true,
"isArchive": true
}
}
}

発注書を更新（差分）

未送信キーは不変。purchaseOrderLines 指定時のみ全置換。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

object

更新対象の発注書参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

発注先。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

発注先担当者参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

object or null

担当ユーザ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

部署参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

宛先ユーザ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

title

string or null

表題

deliveryAddress

string or null

Enum: "CompanyAddress" "SiteAddress"

配送先区分

note

string or null

備考

taxType

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

object or null

ドキュメントテンプレート参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

deliveredAt

string or null <date-time>

納品日（ヘッダ）

deliveryTime

string or null <date-time>

納期（ヘッダ）

unitPriceRoundingType

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

unitPriceRoundingDigit

number [ 0 .. 2 ]

単価の端数を処理する桁数（0〜2）

subTotalRoundingType

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

string

Enum: "Down" "Up" "Off"

税の端数処理方法

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (ExternalUpdatePurchaseOrderLineDto)

発注書明細。指定時は全置換

Array

label

required

string

品名

quantity

required

string^-?\d+(\.\d+)?$

数量

unitPrice

required

string^-?\d+(\.\d+)?$

単価

unitName

string or null

単位

modelName

string or null

型番

object

価格表アイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

note

string or null

明細備考

sortNum

number or null

並び順

isParentLine

boolean

Default: false

親行フラグ

isTextLine

required

boolean

Default: false

テキスト行フラグ

object

メーカー参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveryTime

string or null <date-time>

明細の納期

Array of objects (ExternalUpdatePurchaseOrderTagDto)

タグ（指定時の扱いは内部仕様に準拠）

Array

name required	string タグ名
color required	string タグ色（HEX）

Responses

Response Schema: application/json

required

object (ExternalPurchaseOrderFull)

id

required

string

発注書ID

createdAt

required

string <date-time>

作成日

updatedAt

required

string <date-time>

更新日

slug

required

string

発注番号

title

string or null

発注書名

type

required

string (PurchaseOrderType)

Enum: "JOB" "INVENTORY"

taxType

required

string

Enum: "TaxIncluded" "TaxExcluded" "TaxExempted"

税区分

unitPriceRoundingDigit

required

number

単価の端数を処理する桁数

unitPriceRoundingType

required

string

Enum: "Down" "Up" "Off"

単価の端数処理方法

subTotalRoundingType

required

string

Enum: "Down" "Up" "Off"

小計の端数処理方法

taxRoundingType

required

string

Enum: "Down" "Up" "Off"

消費税の端数処理方法

issuedAt

string or null <date-time>

発注日

receivedAt

string or null <date-time>

受領日

deliveredAt

string or null <date-time>

納品日

paidAt

string or null <date-time>

支払日

partiallyPaidAt

string or null <date-time>

一部支払日

paidAmount

string or null^-?\d+(\.\d+)?$

既支払金額

note

string or null

備考

deliveryAddress

string (DeliveryAddressType)

Enum: "CompanyAddress" "SiteAddress"

配送先区分

deliveryTime

string or null <date-time>

発注書単位の納期

billingDate

string or null <date-time>

被請求日

paymentDueDate

string or null <date-time>

支払期日

externalId

string or null

外部ID

isArchive

required

boolean

アーカイブフラグ

object or null

仕事

id required	string 仕事ID
externalId	string or null 仕事外部ID

required

object

発注先

id

required

string

発注先ID

externalId

string or null

発注先外部ID

isArchive

required

boolean

required

Array of objects (ExternalSellerContactForPurchaseOrder)

Array

id required	string 発注先担当者ID
isArchive required	boolean

required

object

担当者

id required	string 担当者ID
externalId	string or null 担当者外部ID
isArchive required	boolean

object or null

受取人

id required	string 受取人ID
externalId	string or null 受取人外部ID
isArchive required	boolean

required

Array of objects (ExternalTagForPurchaseOrder)

タグ

Array

id required	string タグID
name required	string タグ名
color required	string タグの色

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

required

Array of objects (ExternalPurchaseOrderLineForFindOne)

書類行

Array

id

required

string

プロワンが発行した明細行ID

label

required

string

書類行アイテム名

unitPrice

string or null^-?\d+(\.\d+)?$

書類行単価

quantity

string or null^-?\d+(\.\d+)?$

書類行数量

unitName

string or null

単位

modelName

string or null

型番

deliveryTime

string or null

書類行納期

priceBookItemId

string or null

ID

note

string or null

書類備考

keyPath

required

string

階層構造をUUID v4の . 区切りで表現した値

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

deliveredAt

string or null <date-time>

書類行納品日

billingDate

string or null <date-time>

書類行被請求日

paymentDueDate

string or null <date-time>

書類行支払期日

sortNum

number or null

isTextLine

required

boolean

manufacturerId

string or null

メーカー

object or null

id

required

string

メーカー

Array of objects (ExternalPaymentEntity)

支払い履歴

Array

id required	string 支払い履歴ID
createdAt required	string <date-time> 支払い履歴登録日
updatedAt required	string <date-time> 支払い履歴更新日
date required	string <date-time> 支払い履歴実入金日
amount required	string^-?\d+(\.\d+)?$ 支払い履歴実入金額
notes	string or null 支払い履歴社内メモ

object or null

現在の版

id

required

string

版ID

documentHistoryId

string or null

版ID

hasBeenIssuedBefore

required

boolean

発行履歴あり

latestApprovalRequestDraft

object or null

承認申請下書き

latestApprovalRequest

object or null

承認申請

required

object

承認申請設定

id required	string 承認申請設定ID
isRequired required	boolean
isArchive required	boolean

Request samples

Payload

Content type

application/json

{"purchaseOrder": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"seller": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"sellerContact": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"user": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"division": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"recipient": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"title": "string",
"deliveryAddress": "CompanyAddress",
"note": "string",
"taxType": "TaxIncluded",
"documentTemplate": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"deliveredAt": "2019-08-24T14:15:22Z",
"deliveryTime": "2019-08-24T14:15:22Z",
"unitPriceRoundingType": "Down",
"unitPriceRoundingDigit": 2,
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"label": "室外機",
"quantity": "1",
"unitPrice": "75000",
"unitName": "台",
"modelName": "R22LJXS",
"priceBookItem": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"note": "string",
"sortNum": 0,
"isParentLine": false,
"isTextLine": false,
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"customFields": {"property1": "string",
"property2": "string"
},
"deliveryTime": "2019-08-24T14:15:22Z"
}
],
"tags": [{"name": "重要",
"color": "#RRGGBB"
}
]
}

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-01T00:00:00.000Z",
"updatedAt": "2025-01-01T00:00:00.000Z",
"slug": "PO-2025-0001",
"title": "〇〇様向け発注書",
"type": "JOB",
"taxType": "TaxExcluded",
"unitPriceRoundingDigit": 2,
"unitPriceRoundingType": "Down",
"subTotalRoundingType": "Down",
"taxRoundingType": "Down",
"issuedAt": "2025-01-01T00:00:00.000Z",
"receivedAt": "2025-01-05T00:00:00.000Z",
"deliveredAt": "2025-01-10T00:00:00.000Z",
"paidAt": "2025-01-15T00:00:00.000Z",
"partiallyPaidAt": "2025-01-12T00:00:00.000Z",
"paidAmount": "50000",
"note": "至急手配お願いします",
"deliveryAddress": "CompanyAddress",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"billingDate": "2025-02-01T00:00:00.000Z",
"paymentDueDate": "2025-02-28T00:00:00.000Z",
"externalId": "ext_purchase_order_12345",
"isArchive": false,
"job": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-job-12345"
},
"seller": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-seller-12345",
"isArchive": true,
"sellerContacts": [{"id": "cl3l7lqsj3303015nraag2rho",
"isArchive": true
}
]
},
"user": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"recipient": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-user-12345",
"isArchive": true
},
"tags": [{"id": "cl3l7lqsj3303015nraag2rho",
"name": "緊急",
"color": "#FF0000"
}
],
"customFields": {"property1": "string",
"property2": "string"
},
"purchaseOrderLines": [{"id": "cl3l7lqsj3303015nraag2rho",
"label": "配管材料一式",
"unitPrice": "1000",
"quantity": "2",
"unitName": "式",
"modelName": "ABC-123",
"deliveryTime": "2025-01-31T00:00:00.000Z",
"priceBookItemId": "pb_item_12345",
"note": "至急手配お願いします",
"keyPath": "a4b54201-b64c-4d97-8abb-5581ffb68496.9a70feab-5a56-48f6-a47f-e892c6739d84",
"customFields": {"property1": "string",
"property2": "string"
},
"deliveredAt": "2025-02-01T00:00:00.000Z",
"billingDate": "2025-02-05T00:00:00.000Z",
"paymentDueDate": "2025-02-29T00:00:00.000Z",
"sortNum": 0,
"isTextLine": true,
"manufacturerId": "cl3l7lqsj3303015nraag2rho",
"manufacturer": {"id": "cl3l7lqsj3303015nraag2rho"
}
}
],
"payments": [{"id": "cl3l7lqsj3303015nraag2rho",
"createdAt": "2025-01-10T00:00:00.000Z",
"updatedAt": "2025-01-10T00:00:00.000Z",
"date": "2025-01-10T00:00:00.000Z",
"amount": "50000",
"notes": "前払分"
}
],
"latestDocumentHistory": {"id": "cl3l7lqsj3303015nraag2rho"
},
"documentHistoryId": "cl3l7lqsj3303015nraag2rho",
"hasBeenIssuedBefore": true,
"latestApprovalRequestDraft": { },
"latestApprovalRequest": { },
"approvalRequestSetting": {"id": "cl3l7lqsj3303015nraag2rho",
"isRequired": true,
"isArchive": true
}
}
}

部署

部署の詳細を取得（ID）

IDで部署の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

id

required

string

Example: cl3l7lqsj3303015nraag2rho

部署ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object (ExternalDivisionFull)

id

required

string

部署ID

externalId

string or null

部署外部ID

name

required

string

部署名

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

shortcode

required

string

部署記号

isArchive

required

boolean

アーカイブフラグ

parentDivisionId

string or null

親部署のID(nullの場合はトップ階層の部署)

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

keyPath

required

string

階層構造のパス（ドット区切り）

companyId

string or null

会社ID

childIds

required

Array of strings

直下の子部署IDの配列（isArchive=false かつ isServiceAccountDivision=false）

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-div-12345",
"name": "営業部",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "千代田区",
"address1": "千代田1-1-1",
"address2": "オフィスビル5F",
"shortcode": "DIV001",
"isArchive": false,
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"createdAt": "2024-01-01T09:00:00.000Z",
"updatedAt": "2024-01-02T10:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"keyPath": "division1.division2",
"companyId": "cl3l7lqsj3303015nraag2rhc",
"childIds": ["div_child_1",
"div_child_2"
]
}
}

部署を更新（ID）

IDで部署を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

id

required

string

Example: cl3l7lqsj3303015nraag2rho

部署ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

name

string or null

部署名（同一階層で重複不可）

shortcode

string or null <= 6 characters

部署記号（最大6文字）

parentDivisionId

string or null

親部署のID（最上位部署の場合はTOP_LEVEL_IDを指定）。親部署を指定して部署の階層を移動すると、その配下の全ての子部署も一緒に移動し、keyPath（階層）が自動的に更新されます。例：子部署をトップレベルに移動すると、孫部署も一緒に移動しますが、孫部署の親は子部署のまま維持されます

externalId

string or null

部署外部ID

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県（正式名称）

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object (ExternalDivisionFull)

id

required

string

部署ID

externalId

string or null

部署外部ID

name

required

string

部署名

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

shortcode

required

string

部署記号

isArchive

required

boolean

アーカイブフラグ

parentDivisionId

string or null

親部署のID(nullの場合はトップ階層の部署)

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

keyPath

required

string

階層構造のパス（ドット区切り）

companyId

string or null

会社ID

childIds

required

Array of strings

直下の子部署IDの配列（isArchive=false かつ isServiceAccountDivision=false）

Request samples

Payload

Content type

application/json

{"name": "営業部",
"shortcode": "DIV001",
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"externalId": "ext-div-12345",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-div-12345",
"name": "営業部",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "千代田区",
"address1": "千代田1-1-1",
"address2": "オフィスビル5F",
"shortcode": "DIV001",
"isArchive": false,
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"createdAt": "2024-01-01T09:00:00.000Z",
"updatedAt": "2024-01-02T10:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"keyPath": "division1.division2",
"companyId": "cl3l7lqsj3303015nraag2rhc",
"childIds": ["div_child_1",
"div_child_2"
]
}
}

部署の詳細を取得（外部ID）

外部ID（externalId）で部署の詳細データを取得するためのAPIです。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: division-123

部署の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

required

object (ExternalDivisionFull)

id

required

string

部署ID

externalId

string or null

部署外部ID

name

required

string

部署名

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

shortcode

required

string

部署記号

isArchive

required

boolean

アーカイブフラグ

parentDivisionId

string or null

親部署のID(nullの場合はトップ階層の部署)

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

keyPath

required

string

階層構造のパス（ドット区切り）

companyId

string or null

会社ID

childIds

required

Array of strings

直下の子部署IDの配列（isArchive=false かつ isServiceAccountDivision=false）

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-div-12345",
"name": "営業部",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "千代田区",
"address1": "千代田1-1-1",
"address2": "オフィスビル5F",
"shortcode": "DIV001",
"isArchive": false,
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"createdAt": "2024-01-01T09:00:00.000Z",
"updatedAt": "2024-01-02T10:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"keyPath": "division1.division2",
"companyId": "cl3l7lqsj3303015nraag2rhc",
"childIds": ["div_child_1",
"div_child_2"
]
}
}

部署を更新（外部ID）

外部ID（externalId）で部署を指定して更新するためのAPIです。部分更新が可能です。

Authorizations:

api_key

path Parameters

externalId

required

string

Example: division-123

部署の外部ID

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

name

string or null

部署名（同一階層で重複不可）

shortcode

string or null <= 6 characters

部署記号（最大6文字）

parentDivisionId

string or null

親部署のID（最上位部署の場合はTOP_LEVEL_IDを指定）。親部署を指定して部署の階層を移動すると、その配下の全ての子部署も一緒に移動し、keyPath（階層）が自動的に更新されます。例：子部署をトップレベルに移動すると、孫部署も一緒に移動しますが、孫部署の親は子部署のまま維持されます

externalId

string or null

部署外部ID

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県（正式名称）

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object (ExternalDivisionFull)

id

required

string

部署ID

externalId

string or null

部署外部ID

name

required

string

部署名

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

shortcode

required

string

部署記号

isArchive

required

boolean

アーカイブフラグ

parentDivisionId

string or null

親部署のID(nullの場合はトップ階層の部署)

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

keyPath

required

string

階層構造のパス（ドット区切り）

companyId

string or null

会社ID

childIds

required

Array of strings

直下の子部署IDの配列（isArchive=false かつ isServiceAccountDivision=false）

Request samples

Payload

Content type

application/json

{"name": "営業部",
"shortcode": "DIV001",
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"externalId": "ext-div-12345",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-div-12345",
"name": "営業部",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "千代田区",
"address1": "千代田1-1-1",
"address2": "オフィスビル5F",
"shortcode": "DIV001",
"isArchive": false,
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"createdAt": "2024-01-01T09:00:00.000Z",
"updatedAt": "2024-01-02T10:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"keyPath": "division1.division2",
"companyId": "cl3l7lqsj3303015nraag2rhc",
"childIds": ["div_child_1",
"div_child_2"
]
}
}

部署を作成

部署を新規作成するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

name

required

string

部署名

shortcode

required

string <= 6 characters

部署記号（最大6文字）

parentDivisionId

required

string

親部署のID（最上位部署の場合はTOP_LEVEL_IDを指定）

externalId

string or null

部署外部ID

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県（正式名称）

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Responses

Response Schema: application/json

required

object (ExternalDivisionFull)

id

required

string

部署ID

externalId

string or null

部署外部ID

name

required

string

部署名

phone

string or null

電話番号

fax

string or null

FAX番号

zipcode

string or null

郵便番号

state

string or null

都道府県

city

string or null

市区町村

address1

string or null

住所1

address2

string or null

住所2

shortcode

required

string

部署記号

isArchive

required

boolean

アーカイブフラグ

parentDivisionId

string or null

親部署のID(nullの場合はトップ階層の部署)

createdAt

required

string <date-time>

作成日時

updatedAt

required

string <date-time>

更新日時

required

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

keyPath

required

string

階層構造のパス（ドット区切り）

companyId

string or null

会社ID

childIds

required

Array of strings

直下の子部署IDの配列（isArchive=false かつ isServiceAccountDivision=false）

Request samples

Payload

Content type

application/json

{"name": "営業部",
"shortcode": "DIV001",
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"externalId": "ext-div-12345",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "中央区",
"address1": "銀座7-16-12",
"address2": "G7ビル8階",
"customFields": {"property1": "string",
"property2": "string"
}
}

Response samples

Content type

application/json

{"data": {"id": "cl3l7lqsj3303015nraag2rho",
"externalId": "ext-div-12345",
"name": "営業部",
"phone": "03-1234-5678",
"fax": "03-1234-5679",
"zipcode": "100-0001",
"state": "東京都",
"city": "千代田区",
"address1": "千代田1-1-1",
"address2": "オフィスビル5F",
"shortcode": "DIV001",
"isArchive": false,
"parentDivisionId": "cl3l7lqsj3303015nraag2rhp",
"createdAt": "2024-01-01T09:00:00.000Z",
"updatedAt": "2024-01-02T10:00:00.000Z",
"customFields": {"property1": "string",
"property2": "string"
},
"keyPath": "division1.division2",
"companyId": "cl3l7lqsj3303015nraag2rhc",
"childIds": ["div_child_1",
"div_child_2"
]
}
}

部署をアーカイブ

リクエストしたID/外部IDで対象の1件の部署をアーカイブするためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 部署ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 部署ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "div-123"
}

Response samples

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "div-123",
"isArchive": true
}

部署のアーカイブを解除

リクエストしたID/外部IDで対象の1件の部署のアーカイブを解除するためのAPIです。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

id	string or null 部署ID
externalId	string or null 外部ID

Responses

Response Schema: application/json

id required	string 部署ID
externalId	string or null 外部ID
isArchive required	boolean アーカイブフラグ

Request samples

Payload

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "div-123"
}

Response samples

Content type

application/json

{"id": "cl5c0bcz318351015l39r39wao",
"externalId": "div-123",
"isArchive": true
}

価格表アイテム Bulk (PriceBookItem)

価格表アイテムの一括作成

価格表アイテムを一括で作成する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkCreatePriceBookItemDto) [ 1 .. 100 ] items

作成するアイテム一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

name

required

string

品名

required

object

価格表参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

unitPrice

required

string^-?\d+(\.\d+)?$

単価

unitCost

string or null^-?\d+(\.\d+)?$

原価

unitName

string or null

単位

unitListPrice

string or null^-?\d+(\.\d+)?$

定価単価

unitListPriceString

string or null

定価単価（文字列）

discountPrice

string or null^-?\d+(\.\d+)?$

割引価格

note

string or null

備考

internalNote

string or null

社内メモ

modelName

string or null

型番

taxCode

string or null

税区分コード

externalId

string or null

外部ID

imagePath

string or null

Deprecated

画像パス（bulk API では値指定不可。フィールドは将来対応用に残置）

object or null

ディレクトリ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

メーカー参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

object or null

カテゴリ参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

object

カスタム項目

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (IdOrExternalIdReferenceDto)

子アイテム参照一覧（{ id } または { externalId } の配列）

Array

id	string プロワンが発行したID
externalId	string 外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"name": "string",
"priceBook": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"unitPrice": "1000",
"unitCost": "string",
"unitName": "string",
"unitListPrice": "string",
"unitListPriceString": "string",
"discountPrice": "string",
"note": "string",
"internalNote": "string",
"modelName": "string",
"taxCode": "string",
"externalId": "string",
"imagePath": "string",
"directory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"category": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"customFields": {"property1": "string",
"property2": "string"
},
"childItems": [{"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
]
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表アイテムの一括更新

価格表アイテムを一括で更新する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkUpdatePriceBookItemDto) [ 1 .. 100 ] items

更新するアイテム一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

unitCost

string or null^-?\d+(\.\d+)?$

原価

unitName

string or null

単位

unitListPrice

string or null^-?\d+(\.\d+)?$

定価単価

unitListPriceString

string or null

定価単価（文字列）

discountPrice

string or null^-?\d+(\.\d+)?$

割引価格

note

string or null

備考

internalNote

string or null

社内メモ

modelName

string or null

型番

taxCode

string or null

税区分コード

externalId

string or null

外部ID

object or null

ディレクトリ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

メーカー参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

object or null

カテゴリ参照。:idのいずれか1つ以上を指定。

id

required

string

プロワンが発行したID

required

object

更新対象のアイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

name

string

品名（null / 空白のみは不可）

object

価格表参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

unitPrice

string^-?\d+(\.\d+)?$

単価（null は不可）

object

カスタム項目（上書きで更新。空にする場合は {} を指定。null は不可）

additional property	string or number or boolean or Array of strings or string or null
One of string

Array of objects (IdOrExternalIdReferenceDto)

子アイテム参照一覧（{ id } または { externalId } の配列で全置換、[] で全削除、null は不可）

Array

id	string プロワンが発行したID
externalId	string 外部ID

imagePath

string or null

Deprecated

画像パス（bulk API では値指定不可。フィールドは将来対応用に残置）

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"unitCost": "string",
"unitName": "string",
"unitListPrice": "string",
"unitListPriceString": "string",
"discountPrice": "string",
"note": "string",
"internalNote": "string",
"modelName": "string",
"taxCode": "string",
"externalId": "string",
"directory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"manufacturer": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"category": {"id": "clgwykodu0000hjlh5v3of2p6"
},
"item": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"name": "string",
"priceBook": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"unitPrice": "string",
"customFields": {"property1": "string",
"property2": "string"
},
"childItems": [{"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
],
"imagePath": "string"
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表アイテムの一括削除

価格表アイテムを一括で論理削除する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkDeletePriceBookItemDto) [ 1 .. 100 ] items

削除するアイテム一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

required

object

削除対象のアイテム参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"item": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

Bulk ジョブの進捗確認

ジョブの進捗状況を取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブの成功行一覧

成功した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブのエラー行一覧

エラーが発生した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

価格表本体 Bulk (PriceBook)

価格表本体の一括作成

価格表本体を一括で作成する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkCreatePriceBookDto) [ 1 .. 100 ] items

作成する価格表一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

name

required

string

価格表名

required

object

事業部参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

externalId

string or null

外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"name": "string",
"division": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"externalId": "string"
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表本体の一括更新

価格表本体を一括で更新する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkUpdatePriceBookDto) [ 1 .. 100 ] items

更新する価格表一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

externalId

string or null

外部ID

required

object

更新対象の価格表参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

name

string

価格表名（null / 空白のみは不可）

object

事業部参照（UI で必須のため null 不可）。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"externalId": "string",
"priceBook": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"name": "string",
"division": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表本体の一括削除

価格表本体を一括で論理削除する。非同期処理でジョブIDを返す。bulk-delete は親 PriceBook を archive (isArchive=true) した時点で row 成功を返す。配下の PriceBookItem / PriceBookDirectory および関連 EstimateTemplateLine の cleanup は非同期で実行されるため (eventual consistency)、ジョブ完了直後は配下が未消化である場合がある。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkDeletePriceBookDto) [ 1 .. 100 ] items

削除する価格表一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

required

object

削除対象の価格表参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"priceBook": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

Bulk ジョブの進捗確認

ジョブの進捗状況を取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブの成功行一覧

成功した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブのエラー行一覧

エラーが発生した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

価格表ディレクトリ Bulk (PriceBookDirectory)

価格表ディレクトリの一括作成

価格表ディレクトリを一括で作成する。非同期処理でジョブIDを返す。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkCreatePriceBookDirectoryDto) [ 1 .. 100 ] items

作成するディレクトリ一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

name

required

string

フォルダ名

object or null

所属価格表参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

object or null

親フォルダ参照（null でトップ階層）。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

imagePath

string or null

画像パス

externalId

string or null

外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"name": "string",
"priceBook": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"superDirectory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"imagePath": "string",
"externalId": "string"
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表ディレクトリの一括更新

価格表ディレクトリを一括で更新する。非同期処理でジョブIDを返す。priceBook（所属価格表）は変更不可（UI境界整合）。制約: 同一 row 内で name と superDirectory を同時に送信した場合、service 側の整合性チェックにより該当 row は UNEXPECTED_ERROR で失敗する。名前変更と階層変更を行う場合は、別 row（同一ジョブ内の別エントリ）もしくは別ジョブに分割すること。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkUpdatePriceBookDirectoryDto) [ 1 .. 100 ] items

更新するディレクトリ一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

object or null

親フォルダ参照（null でトップ階層）。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

imagePath

string or null

画像パス

externalId

string or null

外部ID

required

object

更新対象のディレクトリ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

name

string

フォルダ名（null / 空白のみは不可）

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"superDirectory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"imagePath": "string",
"externalId": "string",
"directory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
},
"name": "string"
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

価格表ディレクトリの一括削除

価格表ディレクトリを一括で論理削除する。非同期処理でジョブIDを返す。配下のディレクトリ・価格表アイテムも連動して論理削除される。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

header Parameters

x-api-key required	string
x-api-version	string

Request Body schema: application/json
required

required

Array of objects (ExternalBulkDeletePriceBookDirectoryDto) [ 1 .. 100 ] items

削除するディレクトリ一覧 (1〜100 件)

Array ([ 1 .. 100 ] items)

required

object

削除対象のディレクトリ参照。:id, :externalIdのいずれか1つ以上を指定。

id	string プロワンが発行したID
externalId	string 外部ID

Responses

Response Schema: application/json

statusCode required	boolean Default: 200 ステータスコード
success required	boolean Default: true 成功フラグ
jobId required	string ジョブID
status required	string ジョブステータス
statusUrl required	string 進捗確認URL

Request samples

Payload

Content type

application/json

{"items": [{"directory": {"id": "clgwykodu0000hjlh5v3of2p6",
"externalId": "ex_001"
}
}
]
}

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"status": "queued",
"statusUrl": "string"
}

Bulk ジョブの進捗確認

ジョブの進捗状況を取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブの成功行一覧

成功した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

Bulk ジョブのエラー行一覧

エラーが発生した行の一覧をページングで取得する。

本APIの利用をご希望の場合は、担当営業までお問い合わせください。

Authorizations:

api_key

path Parameters

jobId

required

string

query Parameters

page	number >= 1 Default: 1 ページ番号 (1 始まり)
perPage	number [ 1 .. 1000 ] Default: 100 1 ページあたりの件数 (上限 1000)

header Parameters

x-api-key required	string
x-api-version	string

Responses

Response Schema: application/json

statusCode

required

boolean

Default: 200

ステータスコード

success

required

boolean

Default: true

成功フラグ

jobId

required

string

ジョブID

resourceType

required

string

リソースタイプ

operationType

required

string

操作タイプ

status

required

string

ジョブステータス

required

object

進捗サマリ

total required	number 総行数
queued required	number 待機中の行数
processing required	number 処理中の行数
succeeded required	number 成功した行数
failed required	number 失敗した行数

createdAt

required

string <date-time>

作成日時

startedAt

string or null <date-time>

処理開始日時

finishedAt

string or null <date-time>

処理完了日時

Array of objects (ExternalBulkRowResult)

成功行一覧（GET /:jobId/results）

Array

rowNumber required	number 行番号（0始まり）
id required	string 作成/更新されたエンティティのID
externalId	string 外部ID

resultTotal

number

成功行の総数

Array of objects (ExternalBulkRowError)

エラー行一覧（GET /:jobId/errors）

Array

rowNumber required	number 行番号（0始まり）
id	string エンティティID（処理途中で失敗した場合）
externalId	string 外部ID
errorCode required	string Value: "UNEXPECTED_ERROR" UNEXPECTED_ERROR のみ。
message required	string エラー内容

errorTotal

number

エラー行の総数

page

number

現在のページ

perPage

number

1ページあたりの件数

hasNext

boolean

次ページがあるか

Response samples

Content type

application/json

{"statusCode": 200,
"success": true,
"jobId": "string",
"resourceType": "string",
"operationType": "string",
"status": "string",
"summary": {"total": 0,
"queued": 0,
"processing": 0,
"succeeded": 0,
"failed": 0
},
"createdAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"results": [{"rowNumber": 0,
"id": "string",
"externalId": "string"
}
],
"resultTotal": 0,
"errors": [{"rowNumber": 0,
"id": "string",
"externalId": "string",
"errorCode": "UNEXPECTED_ERROR",
"message": "PriceBook not found"
}
],
"errorTotal": 0,
"page": 0,
"perPage": 0,
"hasNext": true
}

ProOne External APIs documents (α version)

はじめに

利用開始までの流れ

Step 1. API利用規約を確認する

Step 2. プロワンにログインする

Step 3. API Key を申請する

Step 4. API の動作確認をする

API 共通情報

API エンドポイント

利用規約

認証

漏洩リスク

バージョニング

サポートされる API バージョン

利用制限

エラー

レスポンスコード

レスポンスボディ

Error

ページネーション

ページネーションパラメータ

ページネーションレスポンス

変更履歴

2024-03-05

一覧APIのメソッドをGETからPOSTへ変更しました

API のドメインを変更しました

認証方法を変更しました

仕事

仕事詳細を取得

Authorizations:

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

仕事一覧を取得

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

仕事を作成または更新

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

顧客

顧客の詳細を取得

Authorizations:

path Parameters

header Parameters

Responses

Response Schema: application/json

Response samples

顧客一覧を取得

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

顧客（個人）を作成または更新

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

顧客（個人）を更新

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required