GetAccountInvoices

POST

https://api.voximplant.com/platform_api/GetAccountInvoices

POST

/platform_api/GetAccountInvoices

curl -X POST https://api.voximplant.com/platform_api/GetAccountInvoices \
     -H "Authorization: Bearer <token>"

200Example 1

{
  "result": [
    {
      "period": {
        "from": "2021-05-11",
        "to": "2021-05-31"
      },
      "amount": {
        "tax_amount": 47.23144604,
        "total_amount": 300,
        "amount_to_pay": 270,
        "discount_amount": 30,
        "currency": "USD"
      },
      "invoice_id": 1,
      "rows": [
        {
          "amount": {
            "tax_amount": 47.23144604,
            "total_amount": 300,
            "amount_to_pay": 207,
            "discount_amount": 30,
            "currency": "USD"
          },
          "service_name": "Phone numbers",
          "taxes": [
            {
              "taxable_measure": 291.37165093,
              "amount": 8.44977788,
              "level": "State",
              "rate": 0.029,
              "name": "Excise Tax (Wireless)",
              "currency": "USD",
              "category": "EXCISE TAXES"
            },
            {
              "taxable_measure": 32.4,
              "amount": 10.8216,
              "level": "Federal",
              "rate": 0.334,
              "name": "Fed USF Paging",
              "currency": "USD",
              "category": "CONNECTIVITY CHARGES"
            },
            {
              "taxable_measure": 291.37216628,
              "amount": 1.09264562,
              "level": "City",
              "rate": 0.00375,
              "name": "NY Local Transit Tax",
              "currency": "USD",
              "category": "SALES AND USE TAXES"
            },
            {
              "taxable_measure": 291.371485,
              "amount": 2.10078841,
              "level": "County",
              "rate": 0.00721,
              "name": "NY MCTD 186c (Wireless)",
              "currency": "USD",
              "category": "EXCISE TAXES"
            },
            {
              "taxable_measure": 291.37216628,
              "amount": 13.11174748,
              "level": "City",
              "rate": 0.045,
              "name": "NY Sales Tax",
              "currency": "USD",
              "category": "SALES AND USE TAXES"
            },
            {
              "taxable_measure": 291.37216628,
              "amount": 11.65488665,
              "level": "State",
              "rate": 0.04,
              "name": "NY Sales Tax",
              "currency": "USD",
              "category": "SALES AND USE TAXES"
            }
          ]
        }
      ],
      "invoice_number": "US-1",
      "invoice_date": "2021-09-31",
      "status": "numbered"
    }
  ],
  "total_count": 1,
  "count": 1
}

Gets all invoices for the specified USD or EUR account.

Example request: GetAccountInvoices example.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

countintegerOptional

Number of invoices to show per page. Default value is 20

offsetintegerOptional

Number of invoices to skip (e.g. if you set count = 20 and offset = 0 the first time, the next time, offset has to be equal to 20 to skip the items shown earlier). Default value is 0

Response

Successful response

resultlist of objectsOptional

Array of the account invoices

total_countintegerOptional

Total number of invoices matching the query parameters

countintegerOptional

Number of returned invoices matching the query parameters