GET/partners/invoice-details

Gets a list of invoice details.

Authorization

oauth2

OAuth 2.0 authentication. For more information, see Authentication and Authorization.

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/invoice-details

Query Parameters

ParameterTypeDescription
year integer 

Year


required
example : 2021 
month integer 

Month


required
minimum : 1
maximum : 12
example : 6 
count integer 

Number of items to get


default : 20
minimum : 1
maximum : 20 
cursor string 

Cursor value


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
invoiceDetails array (InvoiceDetails) 

It provides invoice details based on the customer's usage information.
If the subscription, plan, number of licenses, or number of users is updated, it provides the total amount calculated based on the start date and the end date.
Note that the total amount does not include any adjustment fees or penalties.

 
responseMetaData object (responseMetaData) 

Pagination information

 

InvoiceDetails

PropertyTypeDescription
domainId integer 

Domain ID


readOnly : true 
domain string 

Domain name


readOnly : true 
customerName string 

Customer company or organization name


readOnly : true 
customerCode string 

Customer code


readOnly : true 
settlementItems array (SettlementItems) 

List of items to settle


readOnly : true 

SettlementItems

PropertyTypeDescription
subscriptionId integer 

Subscription ID

 
itemType string 

Settlement item type

  • PRODUCT: Product
  • OPTION_PRODUCT: Option
  • OPTION_PLUS: Option Plus
  • SUMMARY: Sum (PRODUCT + OPTION_PRODUCT + ADJUSTMENT)
  • ADJUSTMENT: Adjustment amount (custom field)
  • PENALTY: Penalty charges

Allowed values : PRODUCT, OPTION_PRODUCT, OPTION_PLUS, SUMMARY, ADJUSTMENT, PENALTY 
startDate string 

Start date

  • It is the start date if itemType is PRODUCT.

format : date
readOnly : true 
endDate string 

End date

  • It is the end date if itemType is PRODUCT.

format : date
readOnly : true 
itemId string 

Item ID

  • It is the productId if itemType is PRODUCT.

    • LINE WORKS Service
      • STD: Standard plan
      • ADV: Advanced plan

  • It is the custom field name if itemType is ADJUSTMENT.

  • It is null if itemType is SUMMARY or PENALTY.


readOnly : true 
plan string 

Contract type

  • TRIAL: Trial
  • MONTHLY: Monthly contract postpay
  • ANNUAL_LICENSE: Annual contract monthly license
  • ANNUAL_PREPAY_LICENSE: Annual contract lump sum license

Applicable contract types by plan group

  • LINE WORKS Service
    • TRIAL: Trial
    • MONTHLY: Monthly contract postpay
    • ANNUAL_LICENSE: Annual contract monthly license
    • ANNUAL_PREPAY_LICENSE: Annual contract lump sum license

Allowed values : TRIAL, MONTHLY, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
licenseCount integer 

Number of licenses


readOnly : true 
memberCount integer 

Number of users


readOnly : true 
quantity integer 

Quantity

  • It is the quantity if the option is addable.
  • Otherwise, it is null.

readOnly : true
nullable : true 
status string 

Subscription status

  • ACTIVE: Active
  • SUSPENDED_TRIALEND: Suspended (Trial ended)

Allowed values : ACTIVE, SUSPENDED_TRIALEND 
discountAmount number 

Discount amount


readOnly : true 
amount number 

Total amount to settle (the final amount to be paid after discount)


readOnly : true 

responseMetaData

PropertyTypeDescription
nextCursor string 

Cursor value for pagination