GET/partners/invoices

請求書リストを取得する。

注意
この API は引き続きご利用いただけますが、ドキュメントは 請求書リストの取得 をご参照ください。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/invoices

Query Parameters

ParameterTypeDescription
year integer 

取得年


required
example : 2021 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
invoices array (Invoices) 

毎月 1 日、パートナーが管理する顧客の前月の利用履歴をもとに請求書を作成する。
利用料金、税金、違約金などの詳細項目やパートナーに請求した金額及び支払い状況に関する情報を表示する。
顧客企業別請求の詳細は InvoiceDetails リソースで確認可能。

 

Invoices

PropertyTypeDescription
invoiceNo integer 

請求書番号


readOnly : true 
invoiceYear integer 

請求年度


readOnly : true 
invoiceMonth integer 

請求月


readOnly : true 
partnerName string 

パートナー会社名


readOnly : true 
usedAmount integer 

利用料金


readOnly : true 
optionPlusAmount integer 

オプションプラス利用料金


readOnly : true 
taxRate number 

消費税率


readOnly : true 
usedTaxAmount integer 

利用料金の消費税


readOnly : true 
optionPlusTaxAmount integer 

オプションプラス利用料金の消費税


readOnly : true 
penaltyAmount integer 

違約金


readOnly : true 
totalAmount integer 

請求金額


readOnly : true 
paymentStatus string 

支払状態

  • NONE : 支払う金額なし
  • PAID : 支払い完了
  • UNPAID : 未払い

Allowed values : NONE, PAID, UNPAID 
paidTime string 

支払い日時


format : date-time
readOnly : true 
issuedTime string 

請求書の発行日時


format : date-time
readOnly : true 

Response Example

example

1{2  "invoices": [3    {4      "invoiceNo": 2084426021,5      "invoiceYear": 20201,6      "invoiceMonth": 8,7      "partnerName": "パートナー会社",8      "usedAmount": 62400,9      "optionPlusAmount": 10000,10      "taxRate": 10,11      "usedTaxAmount": 6240,12      "optionPlusTaxAmount": 1000,13      "penaltyAmount": 0,14      "totalAmount": 79640,15      "paymentStatus": "PAID",16      "paidTime": "2021-09-22T00:00:00.000Z",17      "issuedTime": "2021-09-01T00:00:00.000Z"18    }19  ]20}