POST api/tt_doc_sa/vip-split/cancel/finalize-before-invoice

Request Information

URI Parameters

None.

Body Parameters

VipSplitCancelRequest

Name

Description

Type

Additional information

PaymentGroupId

globally unique identifier

None.

PaymentOwnerToken

globally unique identifier

None.

CoordinatorControlVersion

Collection of byte

Required

Max length: 8

Min length: 8

Request Formats

application/json, text/json

Sample:

{
  "paymentGroupId": "2a9bf951-273d-4b5a-ba84-7fe590f8592e",
  "paymentOwnerToken": "c4d483af-4650-4a4f-95c5-0a970d4ecb0f",
  "coordinatorControlVersion": "QEA="
}

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": "592568a0-ca06-48fb-9aae-b62ec918e94b",
  "activityId": "e9f8e775-5f6c-4f3f-9c96-48b0a0fedb16",
  "coordinatorDocumentId": "014d884a-930d-4ca9-a47a-d18cf43b7077",
  "processState": 1,
  "saleAmount": 4.0,
  "appliedBalanceAmount": 5.0,
  "amountToCollect": 6.0,
  "controlVersion": "QEA=",
  "parts": [
    {
      "$id": "2",
      "documentId": "3cc7aa0f-31cc-41cf-b2b9-d6024a83ef61",
      "documentNumber": "sample string 2",
      "partNumber": 3,
      "partsCount": 4,
      "amount": 5.0,
      "partState": 1,
      "controlVersion": "QEA="
    },
    {
      "$ref": "2"
    }
  ],
  "invoiceDocumentIds": [
    "a8d1f43f-2fda-4911-941e-93f9dda16c7e",
    "29f0daf8-a056-41ec-b039-16a02ffcd2fe"
  ],
  "maximumPayments": 7,
  "paymentsAssigned": 8,
  "lastPaymentRequired": true
}