enpay byGMO Public API (1.2.0)

Download OpenAPI specification:Download

enpay byGMOへのデータ登録、enpay byGMOからのデータ取得を行うためのAPIです。(以下byGMO省略)

認証について

API実行にはアクセストークンが必要です。アクセストークンは、API実行時にHTTPヘッダー（Authorization）にセットしてご利用ください。

アクセストークンは弊社より提供いたします。トークンは施設単位で発行いたしますので、ご利用いただく施設名をご連絡ください。

リクエスト例

$ curl -X GET https://api.staging.enpay.co.jp/v1/ping \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <access_token>'

Security Scheme Type	HTTP
Header parameter name:	Bearer

疎通確認API

疎通確認用のメッセージを返却します。

Responses

Response samples

200

Content type

application/json

{"message": "pong"
}

施設取得API

enpayに登録されている有効な施設の一覧を取得します。

path Parameters

corporationId

required

integer

会社IDを指定します。

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "エンペイ保育園",
"corporationId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"transferStartedAt": "2019-08-24T14:15:22Z"
}
]

クラス取得API

enpayに登録されている有効なクラス一覧を取得します。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer クラスを取得したい施設のIDを指定します。

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"name": "さくら",
"facilityId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

保護者取得API

enpayに登録されている有効な保護者の一覧を取得します。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 保護者を取得したい施設のIDを指定します。

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"firstName": "太郎",
"lastName": "エンペイ",
"facilityId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

保護者登録API

対象の施設に対して、保護者の新規登録を行います。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 保護者を新規登録したい施設のIDを指定します。

Request Body schema: application/json

Array of objects (ParentForInsert)

Responses

Request samples

Payload

Content type

application/json

{"parents": [{"firstName": "太郎",
"lastName": "エンペイ"
}
]
}

Response samples

201

Content type

application/json

[{"id": 1,
"firstName": "太郎",
"lastName": "エンペイ",
"facilityId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

保護者更新API

対象の施設に対して、保護者の更新を行います。
保護者がコドモンと連携をしている場合、更新を行えません。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 保護者を更新したい施設のIDを指定します。

Request Body schema: application/json

Array of objects (ParentForUpdate)

Responses

Request samples

Payload

Content type

application/json

{"parents": [{"id": 1,
"firstName": "太郎",
"lastName": "エンペイ"
}
]
}

Response samples

201

Content type

application/json

[{"id": 1,
"firstName": "太郎",
"lastName": "エンペイ",
"facilityId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

子ども取得API

enpayに登録されている有効な子どもの一覧を取得します。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 子どもを取得したい施設のIDを指定します。

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"firstName": "花子",
"parentId": 1,
"classId": 1,
"codmonId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

子ども登録API

対象の施設に対して、子どもの新規登録を行います。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 保護者を新規登録したい施設のIDを指定します。

Request Body schema: application/json

Array of objects (ChildForInsert)

Responses

Request samples

Payload

Content type

application/json

{"children": [{"firstName": "花子",
"parentId": 1,
"classId": 1
}
]
}

Response samples

201

Content type

application/json

[{"id": 1,
"firstName": "花子",
"parentId": 1,
"classId": 1,
"codmonId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

子ども更新API

対象の施設に対して、子どもの更新を行います。
子どもがコドモンと連携をしている場合、クラスのみ更新を行えます。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 更新する子どもの保護者が所属する施設のIDを指定します。

Request Body schema: application/json

Array of objects (ChildForUpdate)

Responses

Request samples

Payload

Content type

application/json

{"children": [{"id": 1,
"firstName": "花子",
"parentId": 1,
"classId": 1
}
]
}

Response samples

201

Content type

application/json

[{"id": 1,
"firstName": "花子",
"parentId": 1,
"classId": 1,
"codmonId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": null
}
]

請求取得API

enpayに登録されている有効な請求の一覧を取得します。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 請求を取得したい施設のIDを指定します。
targetYearAndMonth required	string Example: 2022-04 対象年月を指定します。

Responses

Response samples

200

Content type

application/json

[{"id": 1,
"targetYearAndMonth": "2022-04",
"totalPrice": 1000,
"status": "BEFORE_REGISTER",
"paidAt": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"sentAt": "2019-08-24T14:15:22Z",
"parentId": 1,
"unpaidInvoiceChanged": 1,
"seq": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invoiceItems": [{"id": 1,
"invoiceId": 1,
"name": "延長保育料",
"count": 1,
"unitPrice": 1000,
"isConvenienceStoreFee": false,
"childId": 1,
"classId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]

請求登録API

対象の施設に所属する保護者に対して、請求の新規登録を行います。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 請求を登録したい施設のIDを指定します。
targetYearAndMonth required	string Example: 2022-04 対象年月を指定します。

Request Body schema: application/json

Array of objects (InvoiceItemForAdding)

Responses

Request samples

Payload

Content type

application/json

{"invoice_items": [{"childId": 1,
"name": "延長保育料",
"unitPrice": 1000,
"count": 1
}
]
}

Response samples

201

Content type

application/json

[{"id": 1,
"targetYearAndMonth": "2022-04",
"totalPrice": 1000,
"status": "BEFORE_REGISTER",
"paidAt": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"sentAt": "2019-08-24T14:15:22Z",
"parentId": 1,
"unpaidInvoiceChanged": 1,
"seq": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invoiceItems": [{"id": 1,
"invoiceId": 1,
"name": "延長保育料",
"count": 1,
"unitPrice": 1000,
"isConvenienceStoreFee": false,
"childId": 1,
"classId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]

請求削除API

指定された請求の削除を行います。statusがBEFORE_CHARGE（請求保存中）の請求のみ削除可能です。

path Parameters

corporationId required	integer 会社IDを指定します。
facilityId required	integer 請求を削除したい施設のIDを指定します。
targetYearAndMonth required	string Example: 2022-04 対象年月を指定します。

Request Body schema: application/json

invoiceIDs

Array of integers

Responses

Request samples

Payload

Content type

application/json

{"invoiceIDs": [1,
2,
3
]
}

Response samples

200

Content type

application/json

[{"id": 1,
"targetYearAndMonth": "2022-04",
"totalPrice": 1000,
"status": "BEFORE_REGISTER",
"paidAt": "2019-08-24T14:15:22Z",
"paymentMethod": "CREDIT_CARD",
"sentAt": "2019-08-24T14:15:22Z",
"parentId": 1,
"unpaidInvoiceChanged": 1,
"seq": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"invoiceItems": [{"id": 1,
"invoiceId": 1,
"name": "延長保育料",
"count": 1,
"unitPrice": 1000,
"isConvenienceStoreFee": false,
"childId": 1,
"classId": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]