swag-webhook-events/spec/definitions/Invoice.yaml
2019-02-20 14:18:53 +03:00

70 lines
2.0 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

description: Данные инвойса
type: object
required:
- id
- shopID
- createdAt
- status
- dueDate
- amount
- currency
- metadata
- product
properties:
id:
description: Идентификатор инвойса
type: string
shopID:
description: Идентификатор магазина
type: string
format: string
createdAt:
description: Дата и время создания
type: string
format: date-time
status:
description: Статус инвойса
type: string
enum:
- unpaid
- cancelled
- paid
- refunded
- fulfilled
reason:
description: Причина отмены или погашения инвойса
type: string
dueDate:
description: Дата и время истечения срока жизни
type: string
format: date-time
amount:
description: |
Стоимость предлагаемых товаров или услуг, в минорных денежных единицах,
например в копейках в случае указания российских рублей в качестве валюты.
type: integer
format: int64
minimum: 1
currency:
description: |
Валюта, символьный код согласно
[RFC 4217](http://www.iso.org/iso/home/standards/currency_codes.htm).
type: string
metadata:
description: Связанные с инвойсом метаданные
type: object
product:
description: Наименование предлагаемых товаров или услуг
type: string
description:
description: Описание предлагаемых товаров или услуг
type: string
cart:
description: |
Корзина с набором позиций продаваемых товаров или услуг
type: array
minItems: 1
maxItems: 100
items:
$ref: '#/definitions/InvoiceCartLine'