invoices_service

Get invoices

get/api/v1/services/invoices

Query parameters

app_idinteger required

App ID

limitinteger
Example:50

Limit

offsetinteger
Example:100

Offset

field_order'id' | 'amount' | 'status' | 'life_time' | 'description' | 'pay_to_address' | 'paid_by_address' | 'date_create' | 'date_paid'
Example:id

Field

type_order'asc' | 'desc'
Example:desc

Type order

search_idstring

Search ID

filter_statusInvoiceStatus[]

Filter status

[
  "pending"
]
currency'TON' | 'USDT'

Currency

overpaymentboolean

Overpayment

startinteger

Start date

endinteger

End date

Response

Invoices

countinteger required

Example response

{
  "items": [
    {
      "id": "60ffb075",
      "amount": "1000000000",
      "overpayment": "1000000000",
      "description": "Test description",
      "status": "pending",
      "pay_to_address": "0:97146a46acc2654y27947f14c4a4b14273e954f78bc017790b41208b0043200b",
      "paid_by_address": "0:97146a46acc2654y27947f14c4a4b14273e954f78bc017790b41208b0043200b",
      "payment_link": "https://app.tonkeeper.com/transfer/UQ....UQ",
      "info": {
        "first_key": "1",
        "second_key": 2
      },
      "date_change": 1690889913000,
      "date_expire": 1690889913000,
      "date_create": 1690889913000
    }
  ],
  "count": 1000
}

Changes

Changed in 8 of the 50 revisions of this API.437

    • for the query request parameter currency, default value TON was removed

      request-parameter-default-value-removed

    • the response's property default value TON was removed for the status

      response-property-default-value-removed

    • added the new optional query request parameter currency

      new-optional-request-parameter

    • added the required property // to the response with the status

      response-required-property-added

    • added the optional property // to the response with the status

      response-optional-property-added

    • added the new optional query request parameter end

      new-optional-request-parameter

    • added the new optional query request parameter start

      new-optional-request-parameter

  • 2596aa00157e21See the full diff
    • removed the required property // from the response with the status

      response-required-property-removed

    • removed the required property // from the response with the status

      response-required-property-removed

    • added the required property // to the response with the status

      response-required-property-added

    • the // response's property type changed from number to string for status

      response-property-type-changed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed