| Payment |
- paymentTransactionId
- unallocatedAmount
- paymentItem
- paymentAllocatedOn
- appliedCustomerBillingRate
- remainingAmount
- itemNo
- serviceTypeName
- serviceId
- receivedAmount
- adjustedAmount
- writeOffAmount
- disputedAmount
- billingCycleSpecificationRef
- billingCycleSpecification
- reversedPaymentAmount
- paymentMethod (all BRM payment methods are supported)
- paymentStatus
|
PaymentOracle:
title: Payment Oracle
description: A payment, extended for BRM REST Services Manager.
allOf:
- $ref: "#/components/schemas/Payment"
- type: object
properties:
billingCycleSpecification:
description: The billing cycle specification associated with the payment.
$ref: '#/components/schemas/BillingCycleSpecificationRefOracle'
unallocatedAmount:
description: The amount of the payment that is unallocated.
$ref: '#/components/schemas/Money'
description: The amount that remains unallocated in the total payment amount
reversedPaymentAmount:
description: The amount of the payment that is reversed.
$ref: '#/components/schemas/Money'
description: The amount of a reversal when payment is reversed
paymentTransactionId:
type: string
title: Payment Transaction ID
description: The payment's transaction ID.
paymentItem:
type: array
description: Payment items which can be assigned to bills.
x-cardinality: "1"
items:
$ref: '#/components/schemas/PaymentItemOracle'
paymentMethod:
description: The payment method.
$ref: '#/components/schemas/PaymentMethodRefOrValueOracle'
paymentStatus:
type: string
title: Payment Status
description: The payment's status.
|
"paymentTransactionId":"T1,85,0",
"unallocatedAmount":{
"unit":"USD",
"value":10.0
},
"paymentItem": [{
"id": "0.0.0.1+-bill+575251",
"amount": null,
"item": {
"id": "B1-2106",
"href": "https://hostname:port/brm/customerBillManagement/v4/customerBill/0.0.0.1+-bill+575251",
"name": null,
"@baseType": "CustomerBill",
"@schemaLocation": null,
"@type": "CustomerBill",
"@referredType": null
},
"taxAmount": null,
"totalAmount": {
"unit": "USD",
"value": 2
},
"@baseType": "PaymentItem",
"@schemaLocation": null,
"@type": "PaymentItemOracle",
"paymentAllocatedOn": "2020-08-01T02:14:03-07:00",
"appliedCustomerBillingRate": [{
"@baseType": "AppliedCustomerBillingRate",
"@schemaLocation": null,
"@type": "AppliedCustomerBillingRateOracle",
"itemNo": "B1-2106,2",
"allocatedAmount": {
"unit": "USD",
"value": -2
}
}]
}]
"billingCycleSpecification":{
"id":"0.0.0.1+-billinfo+102199",
"href":"http://hostname:port/brm/accountManagement/v4/billingCycleSpecification/0.0.0.1+-billinfo+102199"
},
"reversedPaymentAmount":{
"unit":"USD",
"value":0.0
}
paymentMethod: {
"type" : "cash"
"details": {
"receiptId": "BoA-98071",
"receiptDate": "2020-03-01T08:01:56Z"
},
paymentStatus:"Success"
}
|
| Payment_Create |
- billingCycleSpecification
- bills
|
Payment_CreateOracle:
title: Payment Create Oracle
description: A payment, used in payment create requests, extended for BRM REST Services Manager.
allOf:
- $ref: "#/components/schemas/Payment_Create"
- type: object
properties:
billingCycleSpecification:
description: The billing cycle specification associated with the payment.
$ref: '#/components/schemas/BillingCycleSpecificationRefOracle'
bills:
type: array
x-cardinality: "1"
items:
$ref: '#/components/schemas/CustomerBillRefOracle'
|
"billingCycleSpecification":{
"id":"0.0.0.1+-billinfo+102199",
"href":"http://hostname:port/brm/accountManagement/v4/billingCycleSpecification/0.0.0.1+-billinfo+102199"
},
"bills":{
"id":"0.0.0.1+-bill+79091",
"amount":{
"unit":"USD",
"value":50.0
}
|
| Refund |
- billingCycleSpecification
- bill
|
RefundOracle:
title: Refund Oracle
description: A refund, extended for BRM REST Services Manager.
allOf:
- $ref: "#/components/schemas/Refund"
- type: object
properties:
billingCycleSpecification:
description: The billing cycle specification associated with the refund.
$ref: '#/components/schemas/BillingCycleSpecificationRefOracle'
bill:
description: The bill associated with the refund.
$ref: '#/components/schemas/BillRef'
|
{
"id": "0.0.0.1+-item-refund+90658",
"href": "http://hostname:port/brm/payment/v4/refund/0.0.0.1+-item-refund+90658",
"authorizationCode": null,
"correlatorId": "R1-27",
"description": "Item Refund",
"name": "Billing Event Log",
"refundDate": "2020-12-08T22:58:32-08:00",
"status": "Success",
"statusDate": "2020-12-08T22:58:32-08:00",
"account": {
"id": "0.0.0.1+-account+82226",
"href": null,
"description": null,
"name": "Grace W",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "billingAccount"
},
"amount": null,
"channel": {
"id": "0",
"href": null,
"name": "Unspecified",
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": null
},
"payment": {
"id": "0.0.0.1+-item-payment+88145",
"href": "http://hostname:port/brm/payment/v4/payment/0.0.0.1+-item-payment+88145",
"name": null,
"amount": null,
"paymentDate": null,
"@baseType": null,
"@schemaLocation": null,
"@type": null,
"@referredType": "Payment"
},
"paymentMethod": {
"id": null,
"href": null,
"description": null,
"isPreferred": null,
"name": "Cash",
"status": null,
"statusDate": null,
"account": null,
"relatedParty": null,
"validFor": null,
"@baseType": "PaymentMethodRefOrValue",
"@schemaLocation": null,
"@type": "PaymentMethodRefOrValueOracle",
"@referredType": null,
"details": {
"receiptNo": "23456",
"receiptDate": "2020-12-08T22:58:19-08:00"
}
},
"requestor": null,
"taxAmount": null,
"totalAmount": {
"unit": "USD",
"value": 85.0
},
"@baseType": "Refund",
"@schemaLocation": null,
"@type": "RefundOracle",
"billingCycleSpecification": {
"id": "0.0.0.1+-billinfo+85298",
"href": "http://hostname:port/brm/accountManagement/v4/billingCycleSpecification/0.0.0.1+-billinfo+85298",
"name": "Bill Unit(1)"
},
"bill": {
"id": "0.0.0.1+-bill+82899",
"href": "http://hostname:port/brm/customerBillManagement/v4/customerBill/0.0.0.1+-bill+82899",
"@baseType": null,
"@schemaLocation": null,
"@type": "BillRef",
"@referredType": "CustomerBill"
}
}
|