POST api/tt_doc_sa/vip-split/payment/resolve-manual

Request Information

URI Parameters

None.

Body Parameters

VipSplitManualResolutionRequest
NameDescriptionTypeAdditional information
PaymentGroupId

globally unique identifier

None.

PaymentOwnerToken

globally unique identifier

None.

DocumentId

globally unique identifier

None.

PaymentOperationId

globally unique identifier

None.

CoordinatorControlVersion

Collection of byte

None.

PartControlVersion

Collection of byte

None.

Reason

string

None.

ConfirmedNotCharged

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "paymentGroupId": "49ee008c-9887-4d21-8c2b-41a837b7b2ac",
  "paymentOwnerToken": "090b7e01-25d8-423d-b821-a5990c0a12b0",
  "documentId": "b7941725-c2ab-4442-807c-176d1fc9351f",
  "paymentOperationId": "0f756e51-6095-4a8d-985f-2ac6882604f3",
  "coordinatorControlVersion": "QEA=",
  "partControlVersion": "QEA=",
  "reason": "sample string 5",
  "confirmedNotCharged": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VipSplitProcessResponse
NameDescriptionTypeAdditional 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": "69b2fc55-bb58-4408-9068-c439faad2848",
  "activityId": "72db5795-2dca-4191-9843-fc3a6de0cab8",
  "coordinatorDocumentId": "af8fdc07-2964-4182-82ec-c50fe6b4a4d7",
  "processState": 1,
  "saleAmount": 4.0,
  "appliedBalanceAmount": 5.0,
  "amountToCollect": 6.0,
  "controlVersion": "QEA=",
  "parts": [
    {
      "$id": "2",
      "documentId": "350f68cd-a600-435f-906b-819a1b3bfbcd",
      "documentNumber": "sample string 2",
      "partNumber": 3,
      "partsCount": 4,
      "amount": 5.0,
      "partState": 1,
      "controlVersion": "QEA="
    },
    {
      "$ref": "2"
    }
  ],
  "invoiceDocumentIds": [
    "e4c6d34e-6d5d-4da4-b23c-03cbb50f476c",
    "476b9d39-c6c8-4290-ab96-08c9dcb61695"
  ],
  "maximumPayments": 7,
  "paymentsAssigned": 8,
  "lastPaymentRequired": true
}