Invoice

List and manage invoices — generation, payment status, and tax.

Resource base path: /restapi/invoice

Method	Path	Description
GET	/restapi/invoice/listByClient	Invoice List
GET	/restapi/invoice/generateInvoice	Generate Invoice
GET	/restapi/invoice/changeInvoiceCost	Change Invoice Payment Cost
GET	/restapi/invoice/getInvoicePaymentStatus	Invoice Paid Status List
POST	/restapi/invoice/updateInvoiceStatus	Update Invoice Status
POST	/restapi/invoice/updateInvoiceTax	Update Tax Amount
GET	/restapi/invoice/listTaxPendingInvoice	Tax Pending Invoice List

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

---

Invoice List

Invoice List.

GET /restapi/invoice/listByClient

Parameters

Parameter	In	Type	Required	Description
clientEmail	query	string	No	Client email address.
status	query	string	No	One of: DRAFT, DUE, PAID, OVER_DUE, CANCEL, TAX_PENDING.
billPeriod	query	string	No

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/invoice/listByClient" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listInvoiceResponse": [
    {
      "domainUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "adjustmentCost": 0.0,
      "clientEmail": "user@example.com",
      "usageCost": 0.0,
      "referenceNumber": 1,
      "invoiceNumber": "string",
      "generatedDate": 1,
      "totalAdjustmentCost": 0.0,
      "currency": "USD",
      "bandwidthFreeUsage": 0.0,
      "totalCost": 0.0,
      "billPeriod": "string",
      "status": "DRAFT"
    }
  ]
}

---

Generate Invoice

Generate Invoice.

GET /restapi/invoice/generateInvoice

Parameters

Parameter	In	Type	Required	Description
invoiceNumber	query	integer (int32)	✅ Yes

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/invoice/generateInvoice?invoiceNumber=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "invoiceNumber": 1,
  "message": "string",
  "status": "Active"
}

---

Change Invoice Payment Cost

Change Invoice Payment Cost.

GET /restapi/invoice/changeInvoiceCost

Parameters

Parameter	In	Type	Required	Description
invoiceNumber	query	integer (int32)	✅ Yes
payAmount	query	number (double)	✅ Yes

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/invoice/changeInvoiceCost?invoiceNumber=VALUE&payAmount=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "invoiceNumber": 1,
  "message": "string",
  "status": "Active"
}

---

Invoice Paid Status List

Invoice Paid Status List.

GET /restapi/invoice/getInvoicePaymentStatus

Parameters

Parameter	In	Type	Required	Description
id	query	string	✅ Yes

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/invoice/getInvoicePaymentStatus?id=VALUE" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "invoiceTaxResponses": [
    {
      "realNumber": "string",
      "clientEmail": "user@example.com",
      "id": "string",
      "status": "Active"
    }
  ]
}

---

Update Invoice Status

Update Invoice Status.

POST /restapi/invoice/updateInvoiceStatus

Request body

Field	Type	Required	Description
realNumber	string	No
clientEmail	string	No	Client email address.
payment	boolean	No
id	string	No

{
  "realNumber": "string",
  "clientEmail": "user@example.com",
  "payment": true,
  "id": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/invoice/updateInvoiceStatus" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "realNumber": "string",
  "clientEmail": "user@example.com",
  "payment": true,
  "id": "string"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "invoiceTaxResponses": [
    {
      "realNumber": "string",
      "clientEmail": "user@example.com",
      "id": "string",
      "status": "Active"
    }
  ]
}

---

Update Tax Amount

Update Tax Amount.

POST /restapi/invoice/updateInvoiceTax

Request body

Field	Type	Required	Description
total	number (double)	No
realNumber	string	No
taxDetails	array	No
clientEmail	string	No	Client email address.
taxes	number (double)	No
id	string	No

{
  "total": 0.0,
  "realNumber": "string",
  "taxDetails": [
    {
      "description": "string"
    }
  ],
  "clientEmail": "user@example.com",
  "taxes": 0.0,
  "id": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/invoice/updateInvoiceTax" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "total": 0.0,
  "realNumber": "string",
  "taxDetails": [
    {
      "description": "string"
    }
  ],
  "clientEmail": "user@example.com",
  "taxes": 0.0,
  "id": "string"
}'

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "invoiceTaxResponses": [
    {
      "total": 0.0,
      "realNumber": "string",
      "clientEmail": "user@example.com",
      "taxes": 0.0,
      "id": "string",
      "status": "Active"
    }
  ]
}

---

Tax Pending Invoice List

Tax Pending Invoice List.

GET /restapi/invoice/listTaxPendingInvoice

Parameters

Parameter	In	Type	Required	Description
clientEmail	query	string	No	Client email address.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/invoice/listTaxPendingInvoice" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
200	Successful operation.
401	Invalid authentication credentials.
550	Permission denied.

{
  "count": 1,
  "listInvoiceResponse": [
    {
      "amount": 0.0,
      "clientEmail": "user@example.com",
      "currency": "USD",
      "id": "string",
      "billPeriod": "string",
      "status": "Active"
    }
  ]
}