InvoiceDTO

The InvoiceDTO object represents a data structure describing an invoice, including user information, payment details, commission fees, and related transactions.

Field Descriptions

Name	Type	Description
id	string	Unique identifier of the invoice.
internalId	string | null	Invoice identifier in the merchant's system. If not set, the field is null.
userId	string | null	Merchant client's identifier. If not specified, the field is null.
type	DirectionType	Invoice type: incoming or outgoing.
status	InvoiceStatus	Invoice status.
paymentMethod	PaymentMethod | null	Payment method (bank code) specified during creation.
paymentOption	PaymentOption | null	Payment type specified when creating the invoice, e.g., TO_CARD, SBP, etc.
paymentRequisites	RequisitesDTO | null	Payment details for an outgoing invoice (out). Always null for type in.
sum	MoneyDTO	Invoice amount.
storeId	number	Identifier of the store to which the invoice belongs.
storeName	string	Name of the store to which the invoice belongs.
receivedSumFromTaker	MoneyDTO | null	Amount received from the recipient, if applicable.
receivedSumFromMaker	MoneyDTO | null	Amount received from the sender, if applicable.
serviceFeeSum	MoneyDTO | null	Service fee.
payoutSum	MoneyDTO | null	Payout amount, if applicable.
createdAt	string	Invoice creation time in ISO 8601 format.
expireAt	string	Invoice expiration time in ISO 8601 format.
updatedAt	string	Last update time of the invoice in ISO 8601 format.
deals	DealDTO[]	Array of deals associated with this invoice.

Example

{
  "id": "c8a9d474-b35b-4961-9bf4-b049e40dbc5b",
  "internalId": "test-id",
  "userId": "test-uid",
  "type": "in",
  "status": "new",
  "paymentMethod": null,
  "paymentOption": null,
  "paymentRequisites": null,
  "sum": {
    "amount": "120.00",
    "currency": "RUB",
    "subunit": 2
  },
  "storeId": 7,
  "storeName": "Test Store",
  "receivedSumFromTaker": null,
  "receivedSumFromMaker": null,
  "serviceFeeSum": null,
  "payoutSum": null,
  "createdAt": "2024-11-22T10:38:52+00:00",
  "expireAt": "2024-11-22T11:38:52+00:00",
  "updatedAt": "2024-11-22T10:38:52+00:00",
  "invoiceUrl": "https:\/\/{{domain}}\/invoice?id=c8a9d474-b35b-4961-9bf4-b049e40dbc5b",
  "deals": [
    {
      "id": "c8a9d474-b35b-4961-9bf4-b049e40dbc5b",
      "type": "in",
      "status": "transfer_waiting",
      "paymentMethod": "sberbank",
      "paymentOption": "TO_CARD",
      "requisites": {
        "requisites": "2234 2036 5607 2495",
        "holder": "test holder"
      },
      "canceledAt": "2024-11-22T10:43:00+00:00",
      "disputeAttachment": null,
      "disputeReason": null,
      "disputeReasonData": [],
      "payment": null,
      "rate": "97.35",
      "isActive": true,
      "qrCodeLink": "https:\/\/www.sberbank.com\/sms\/pbpn?requisiteNumber=2234203656072495",
      "disputeResult": null,
      "attachments": []
    }
  ]
}