GET/partners/invoices

Gets a list of invoices.

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/invoices

Query Parameters

ParameterTypeDescription
year integer 

Year


required
example : 2021 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
invoices array (Invoices) 

On the 1st of every month, a bill is created based on the previous month's usage of customers managed by the partner.
It includes details such as the amount spent, taxes and penalties, the amount charged to the partner and the payment status.
For detailed billing information for each customer, see InvoiceDetails.

 

Invoices

PropertyTypeDescription
invoiceNo integer 

Invoice number


readOnly : true 
invoiceYear integer 

Invoice year


readOnly : true 
invoiceMonth integer 

Invoice month


readOnly : true 
partnerName string 

Partner name


readOnly : true 
usedAmount integer 

Amount spent


readOnly : true 
taxRate number 

Tax rate


readOnly : true 
usedTaxAmount integer 

Tax


readOnly : true 
penaltyAmount integer 

Penalty charges


readOnly : true 
totalAmount integer 

Amount due


readOnly : true 
paymentStatus string 

Payment status

  • NONE: No payment amount
  • PAID: Payment completed
  • UNPAID: Unpaid

Allowed values : NONE, PAID, UNPAID 
paidTime string 

Payment date and time


format : date-time
readOnly : true 
issuedTime string 

Invoice date and time


format : date-time
readOnly : true 

Response Example

example

1{2  "invoices": [3    {4      "invoiceNo": 2084426021,5      "invoiceYear": 20201,6      "invoiceMonth": 8,7      "partnerName": "Partner company",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}