POST api/tt_doc_sa/vip-split/external/start

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
pos_name	string	Required String length: inclusive between 0 and 50
id_rua	globally unique identifier	None.
payment_group_id	globally unique identifier	None.
terminal_name	string	Required String length: inclusive between 0 and 10
parts_count	integer	Range: inclusive between 0 and 2147483647
custom_amounts	Collection of decimal number	None.
distribution_mode	VipSplitDistributionMode	None.
max_parts	integer	None.
print_doc	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "pos_name": "sample string 1",
  "id_rua": "ca3e3c1c-d8b5-444a-8b07-bf873445ed30",
  "payment_group_id": "868f3dc3-6c9f-48d6-acb9-26cca97f8af9",
  "terminal_name": "sample string 4",
  "parts_count": 5,
  "custom_amounts": [
    1.0,
    2.0
  ],
  "distribution_mode": 0,
  "max_parts": 1,
  "print_doc": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitProcessResponse

Name	Type	Additional information
PaymentGroupId	globally unique identifier	None.
ActivityId	globally unique identifier	None.
CoordinatorDocumentId	globally unique identifier	None.
ProcessState	DocSaProcessState	None.
SaleAmount	decimal number	None.
AppliedBalanceAmount	decimal number	None.
AmountToCollect	decimal number	None.
ControlVersion	Collection of byte	None.
Parts	Collection of VipSplitPaymentPartResponse	None.
InvoiceDocumentIds	Collection of globally unique identifier	None.
MaximumPayments	integer	None.
PaymentsAssigned	integer	None.
LastPaymentRequired	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "paymentGroupId": "b48d002e-a4a5-415a-9609-3d9c43143782",
  "activityId": "00eee02e-406a-4dbd-8b33-ed716d5a4236",
  "coordinatorDocumentId": "b1dc0b1c-434b-47b8-b329-73f35b2b546e",
  "processState": 1,
  "saleAmount": 4.0,
  "appliedBalanceAmount": 5.0,
  "amountToCollect": 6.0,
  "controlVersion": "QEA=",
  "parts": [
    {
      "$id": "2",
      "documentId": "78ad79b1-820b-42bd-8090-847790c3bca8",
      "documentNumber": "sample string 2",
      "partNumber": 3,
      "partsCount": 4,
      "amount": 5.0,
      "partState": 1,
      "controlVersion": "QEA="
    },
    {
      "$ref": "2"
    }
  ],
  "invoiceDocumentIds": [
    "944dc6b0-b988-4326-b037-c36d007b151d",
    "e5ff0831-6b7b-403e-9024-53d54d667817"
  ],
  "maximumPayments": 7,
  "paymentsAssigned": 8,
  "lastPaymentRequired": true
}