Sign in
Buy-out and surplus transaction info view

Retrieve buy-out and surplus transaction details by id

get/v1.0/buy-out-surplus/transactions/{id}/details

Path parameters

idinteger required

The transaction id

Response

OK

idinteger
transactionCodestring
accountBusinessIdstring
operatorNamestring
targetPeriodType'TP5' | 'TP6' | 'TP7' | 'TP8' | 'TP9'
targetPeriodResultType'TARGET_MET' | 'BUY_OUT_REQUIRED' | 'SURPLUS_USED_BUY_OUT_REQUIRED' | 'SURPLUS_USED' | 'OUTSTANDING'
reportVersionstring
submissionType'PRIMARY' | 'SECONDARY'
creationDatestring date-time
dueDatestring date
paymentStatus'AWAITING_PAYMENT' | 'AWAITING_REFUND' | 'PAID' | 'REFUNDED' | 'NOT_REQUIRED' | 'UNDER_APPEAL' | 'TERMINATED'
chargeType'REFUND' | 'FEE'
priBuyOutCarbonstring decimal
priBuyOutCoststring decimal
invoicedBuyOutFeestring decimal
invoicedSurplusGainedstring decimal
invoicedPreviousPaidFeesstring decimal
buyOutFeestring decimal

Changes

Changed in 2 of the 15 revisions of this API.31

  • 0be05036d2c83See the full diff
    • ●

      added the new TP7 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TP8 enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new TP9 enum value to the response property for the response status

      response-property-enum-value-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 15b32331a1ac1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 22 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog