{ "openapi":"3.0.1", "info":{ "title":"REST Services Manager API for Billing and Revenue Management", "description":"The BRM REST Services Manager API supports the following:\n", "version":"2025.09.03", "x-summary":"The BRM REST Services Manager API supports the following: TMF 666: Account Management API Retrieves billing cycle specifications (bill units and bill unit infos in BRM)." }, "tags":[ { "name":"Account Management" }, { "name":"Account Management/Notification Listeners", "description":"The operations from the Account Management/Notification Listeners category." }, { "name":"Customer Bill Management/Applied Customer Billing Rate", "description":"Use for managing applied customer billing rates." }, { "name":"Customer Bill Management/Customer Bill", "description":"Use for managing customer bills." }, { "name":"Customer Bill Management/Customer Bill Invoice", "description":"The operations from the Customer Bill Management/Customer Bill Invoice category." }, { "name":"Customer Bill Management/Customer Bill On Demand", "description":"Use for managing on-demand customer bills." }, { "name":"Order Billing Fulfillment" }, { "name":"Payment Management/Payment", "description":"Use for managing payments." }, { "name":"Payment Management/Refund", "description":"Use for managing refunds." }, { "name":"Payment Method Management", "description":"Use for managing payment methods." }, { "name":"Prepay Balance Management/Accumulated Balances", "description":"Use for managing accumulated balances." }, { "name":"Prepay Balance Management/Adjusted Balances", "description":"Use for managing adjusted balances." }, { "name":"Prepay Balance Management/Balance Actions", "description":"The operations from the Prepay Balance Management/Balance Actions category." }, { "name":"Prepay Balance Management/Bucket Balances", "description":"Use for managing bucket balances." }, { "name":"Prepay Balance Management/Disputed Balances", "description":"Use for managing disputed balances." }, { "name":"Prepay Balance Management/Top-up Balances", "description":"The operations from the Prepay Balance Management/Top-up Balances category." }, { "name":"Prepay Balance Management/Transfer Balances", "description":"The operations from the Prepay Balance Management/Transfer Balances category." }, { "name":"Usage Management", "description":"Use for managing usage." } ], "paths":{ "/billingCycleSpecification":{ "get":{ "tags":[ "Account Management" ], "summary":"Get Billing Cycle Specifications", "description":"Gets the billing cycle specifications that match the specified query criteria.", "operationId":"listBillingCycleSpecification", "parameters":[ { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=billingPeriod,validFor", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=BillingCycleSpecification for a base object, or @type=BillingCycleSpecificationOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"The ID of the billing cycle specification to get.", "example":"id=0.0.0.1+-billinfo+105951", "schema":{ "type":"string" } }, { "name":"frequency", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with the specified billing frequency.", "example":"frequency=monthly", "schema":{ "type":"string" } }, { "name":"billingDateShift", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a billing day of month that matches the specified billing day.", "example":"billingDateShift=13", "schema":{ "type":"integer" } }, { "name":"billingDateShift.gte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a billing day of month that is greater than or equal to the specified billing day.", "example":"billingDateShift.gte=13", "schema":{ "type":"integer" } }, { "name":"billingDateShift.lte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a billing day of month that is less than or equal to the specified billing day.", "example":"billingDateShift.lte=13", "schema":{ "type":"integer" } }, { "name":"billingDateShift.gt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a billing day of month that is greater than the specified billing day.", "example":"billingDateShift.gt=13", "schema":{ "type":"integer" } }, { "name":"billingDateShift.lt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a billing day of month that is less than the specified billing day.", "example":"billingDateShift.lt=13", "schema":{ "type":"integer" } }, { "name":"validFor.startDateTime", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a startDateTime that is equal to the specified date and time.", "example":"validFor.startDateTime=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.startDateTime.gte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a startDateTime that is greater than equal to the specified date and time.", "example":"validFor.startDateTime.gte=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.startDateTime.lte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a startDateTime that is less than or equal to the specified date and time.", "example":"validFor.startDateTime.lte=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.startDateTime.gt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a startDateTime that is greater than the specified date and time.", "example":"validFor.startDateTime.gt=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.startDateTime.lt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a startDateTime that is less than or equal to the specified date and time.", "example":"validFor.startDateTime.lt=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.endDateTime", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with an endDateTime that is equal to the specified date and time.", "example":"validFor.endDateTime=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.endDateTime.gte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with an endDateTime that is greater than or equal to the specified date and time.", "example":"validFor.endDateTime.gte=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.endDateTime.lte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with an endDateTime that is less than or equal to the specified date and time.", "example":"validFor.endDateTime.lte=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.endDateTime.gt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with an endDateTime that is greater than the specified date and time.", "example":"validFor.endDateTime.gt=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"validFor.endDateTime.lt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with an endDateTime that is less than or equal to the specified date and time.", "example":"validFor.endDateTime.lt=2020-05-02T01:15:51-07:00", "schema":{ "type":"string" } }, { "name":"paymentDueDateOffset", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a paymentDueDateOffset that is equal to the specified value.", "example":"paymentDueDateOffset=7", "schema":{ "type":"integer" } }, { "name":"paymentDueDateOffset.gte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than or equal to the specified value.", "example":"paymentDueDateOffset.gte=7", "schema":{ "type":"integer" } }, { "name":"paymentDueDateOffset.lte", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a paymentDueDateOffset that is less than or equal to the specified value.", "example":"paymentDueDateOffset.lte=7", "schema":{ "type":"integer" } }, { "name":"paymentDueDateOffset.gt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a paymentDueDateOffset that is greater than the specified value.", "example":"paymentDueDateOffset.gt=7", "schema":{ "type":"integer" } }, { "name":"paymentDueDateOffset.lt", "in":"query", "required":false, "description":"Retrieves the billing cycle specification with a paymentDueDateOffset that is less than the specified value.", "example":"paymentDueDateOffset.lt=7", "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"billingCycleSpecification-get", "x-filename-id":"billingcyclespecification-get" } }, "/billingCycleSpecification/{id}":{ "get":{ "tags":[ "Account Management" ], "summary":"Get a Billing Cycle Specification by ID", "description":"Gets the specified billing cycle specification.", "operationId":"retrieveBillingCycleSpecification", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the billing cycle specification to get.", "example":"0.0.0.1+-billinfo+105951", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=chargeDateOffset,frequency", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=BillingCycleSpecification for a base object, or @type=BillingCycleSpecificationOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/BillingCycleSpecification" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"billingCycleSpecification-{id}-get", "x-filename-id":"billingcyclespecification-id-get" } }, "/listener/partyAccountCreateEvent":{ "post":{ "operationId":"listenToPartyAccountCreateEvent", "summary":"Create an Account from a PartyAccountCreateEvent Notification", "description":"Creates an account based on a PartyAccountCreateEvent notification.", "tags":[ "Account Management/Notification Listeners" ], "requestBody":{ "description":"The event containing the account information.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/PartyAccountCreateEvent" } } }, "required":true }, "responses":{ "201":{ "description":"Notified" }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"listener-partyAccountCreateEvent-post", "x-filename-id":"listener-partyaccountcreateevent-post" } }, "/listener/partyAccountAttributeValueChangeEvent":{ "post":{ "operationId":"listenToPartyAccountAttributeValueChangeEvent", "summary":"Update an Account from a PartyAccountAttributeValueChangeEvent Notification", "description":"Updates an account's attributes based on PartyAccountAttributeValueChangeEvent notification.", "tags":[ "Account Management/Notification Listeners" ], "requestBody":{ "description":"The event containing the attribute update information.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/PartyAccountAttributeValueChangeEvent" } } }, "required":true }, "responses":{ "201":{ "description":"Notified" }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"listener-partyAccountAttributeValueChangeEvent-post", "x-filename-id":"listener-partyaccountattributevaluechangeevent-post" } }, "/paymentMethod":{ "get":{ "tags":[ "Payment Method Management" ], "summary":"Get Payment Methods", "description":"Gets the payment methods that match the query criteria.", "operationId":"retrievePaymentMethods", "parameters":[ { "name":"type", "in":"query", "description":"The type of payment method to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "enum":[ "tokenizedCard", "bankAccountDebit", "bankCard", "invoice" ] } }, { "name":"name", "in":"query", "description":"The name, to get a payment method.", "examples":{ "getNameExample":{ "value":"Invoice123", "summary":"Invoice123" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.BIC", "in":"query", "description":"The Business Identifier Code of a bank, to get bankAccountDebit payment methods.", "examples":{ "getPMBankBicExample":{ "value":"AAAABBCCDD", "summary":"AAAABBCCDD" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.accountNumber", "in":"query", "description":"The account number, to get a bankAccountDebit payment method.", "examples":{ "getPMBankAccNoExample":{ "value":1234567890, "summary":"1234567890" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.bank", "in":"query", "description":"The name of a bank, to get bankAccountDebit payment methods.", "examples":{ "getPMBankAcBankExample":{ "value":"My Bank", "summary":"My Bank" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.cardNumber", "in":"query", "description":"The card number, to get a bankCard payment method.", "examples":{ "getPMBankCardNoExample":{ "value":"5111111111111118", "summary":"5111111111111118" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.nameOnCard", "in":"query", "description":"The name on the card, to get bankCard payment methods. You can use bankCard.nameOnCard.like= to get partial matches.", "examples":{ "getPMBankCardNameExample":{ "value":"John%20Smith", "summary":"Use bankCard.nameOnCard=John%20Smith to get an exact match, or use bankCard.nameOnCard.like=John%25 to get all bank cards with names that start with John." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.type", "in":"query", "description":"The type of bank card, to get bankCard payment methods. The only valid value for BRM is CREDIT.", "examples":{ "getPMBankTypeExample":{ "value":"CREDIT", "summary":"CREDIT" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"invoice.name", "in":"query", "description":"The name on the invoice, to get invoice payment methods. You can use invoice.name.like= to get partial matches.", "examples":{ "getPMInvoiceNameExample":{ "value":"John%20Smith", "summary":"Use invoice.name=John%20Smith to get an exact match, or use invoice.name.like=John%25 to get all invoice payment methods with name that start with John." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"relatedParty.id", "in":"query", "description":"The ID of a related party to get payment methods for.", "examples":{ "getPMPartyIdExample":{ "value":"0.0.0.1+-account+107117", "summary":"0.0.0.1+-account+107117, 0.0.0.1-107117" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"relatedParty.type", "in":"query", "description":"The type of related party to get payment methods for.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getPMFieldsExample":{ "value":"account,bankCard.nameOnCard", "summary":"fields=account,bankCard.nameOnCard" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getPMLimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"integer" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getPMOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"The payment methods were returned successfully.", "headers":{ "X-Total-Count":{ "description":"The total number of results.", "style":"simple", "explode":false, "schema":{ "type":"integer" } } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PaymentMethodType" } } } } }, "400":{ "description":"Invalid Token" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "405":{ "description":"Method not Allowed" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"paymentMethod-get", "x-filename-id":"paymentmethod-get" }, "post":{ "tags":[ "Payment Method Management" ], "summary":"Create a Payment Method", "description":"Creates a payment method.", "operationId":"createPaymentMethod", "requestBody":{ "description":"The payment method to create.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PaymentMethodRequestType" } } }, "required":true }, "responses":{ "201":{ "description":"The payment method was created successfully.", "headers":{ "location":{ "description":"The location to get the new payment method.", "style":"simple", "explode":false, "schema":{ "type":"string" } } }, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PaymentMethodType" } } } }, "400":{ "description":"Bad Request" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "405":{ "description":"Method not Allowed" }, "409":{ "description":"Conflict" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"paymentMethod-post", "x-filename-id":"paymentmethod-post" } }, "/paymentMethod/{paymentMethodId}":{ "get":{ "tags":[ "Payment Method Management" ], "summary":"Get a Payment Method by ID", "description":"Gets the specified payment method.", "operationId":"retrievePaymentMethod", "parameters":[ { "name":"paymentMethodId", "in":"path", "description":"The ID of the payment method to get.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The payment method was returned successfully.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PaymentMethodType" } } } }, "400":{ "description":"Invalid Token" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "405":{ "description":"Method not Allowed" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"paymentMethod-{paymentMethodId}-get", "x-filename-id":"paymentmethod-paymentmethodid-get" }, "delete":{ "tags":[ "Payment Method Management" ], "summary":"Delete a Payment Method", "description":"Deletes the specified payment method.", "operationId":"deletePaymentMethod", "parameters":[ { "name":"paymentMethodId", "in":"path", "description":"The ID of the payment method to delete.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "204":{ "description":"The payment method was deleted successfully." }, "400":{ "description":"Invalid Token" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "404":{ "description":"Not Found" }, "405":{ "description":"Method not Allowed" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"paymentMethod-{paymentMethodId}-delete", "x-filename-id":"paymentmethod-paymentmethodid-delete" } }, "/accounts/{accountId}/paymentMethods":{ "get":{ "tags":[ "Payment Method Management" ], "summary":"Get Payment Methods for an Account", "description":"Gets the payment methods associated with the specified account.", "operationId":"retrieveAssociatedPaymentMethods", "parameters":[ { "name":"accountId", "in":"path", "description":"The ID of the account to get payment methods for.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"The type of payment methods to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "enum":[ "tokenizedCard", "bankAccountDebit", "bankCard", "invoice" ] } }, { "name":"name", "in":"query", "description":"The name, to get a payment method.", "examples":{ "getNameExample":{ "value":"Invoice123", "summary":"Invoice123" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.BIC", "in":"query", "description":"The Business Identifier Code of a bank, to get bankAccountDebit payment methods.", "examples":{ "getPMABankBicExample":{ "value":"AAAABBCCDD", "summary":"AAAABBCCDD" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.accountNumber", "in":"query", "description":"The bank account number, to get a bankAccountDebit payment method.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankAccount.bank", "in":"query", "description":"The name of a bank, to get bankAccountDebit payment methods.", "examples":{ "getPMABankNameExample":{ "value":"MyName", "summary":"My Bank" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.cardNumber", "in":"query", "description":"The card number, to get a bankCard payment method.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.nameOnCard", "in":"query", "description":"The name on the card, to get bankCard payment methods. You can use bankCard.nameOnCard.like= to get partial matches.", "examples":{ "getPMABankCardNmaeExample":{ "value":"John Smith", "summary":"Use bankCard.nameOnCard=John%20Smith to get an exact match, or use bankCard.nameOnCard.like=John%25 to get all bank cards with names that start with John." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bankCard.type", "in":"query", "description":"The type of bank card, to get bankCard payment methods. The only valid value for BRM is CREDIT.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"invoice.name", "in":"query", "description":"The name on the invoice, to get invoice payment methods. You can use invoice.name.like= to get partial matches.", "examples":{ "getPMInvoiceNameExample":{ "value":"John%20Smith", "summary":"Use invoice.name=John%20Smith to get an exact match, or use invoice.name.like=John%25 to get all invoice payment methods with name that start with John." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "examples":{ "getPMAFieldsExample":{ "value":"status,details.bank", "summary":"fields=status,details.bank" } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "examples":{ "getPMALimitExample":{ "value":10, "summary":"Use limit=10 to return the first 10 results only." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"integer" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "examples":{ "getPMAOffsetExample":{ "value":10, "summary":"Use offset=10 to return results 10 and higher." } }, "required":false, "style":"form", "explode":true, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"The payment methods for the account were returned successfully.", "headers":{ "X-Total-Count":{ "description":"Total results", "style":"simple", "explode":false, "schema":{ "type":"integer" } } }, "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/PaymentMethodType" } } } } }, "400":{ "description":"Invalid Token" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "405":{ "description":"Method not Allowed" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"accounts-{accountId}-paymentMethods-get", "x-filename-id":"accounts-accountid-paymentmethods-get" } }, "/createFulfillBilling":{ "post":{ "tags":[ "Order Billing Fulfillment" ], "summary":"Perform Billing Fulfillment", "description":"Performs the following bill fulfillment processes:

You specify the type of operation to be performed using the productOrderItem.action field in the request payload. Set the field to add, terminate, suspend, or resume.

You can also specify to cancel the service in the future by setting the productOrderItem.requestedCompletionDate field to a future-dated timestamp.

If you support two-phase billing, then you can also specify the offer be purchased with a future activation date using the billFulfillMode field in the request payload. Set the field to initiate to purchase an offer with the start dates set to 365 days in the future, or to fulfill to update the start dates to actual activation dates provided in the payload.", "operationId":"createFulfillBilling", "requestBody":{ "description":"Performs billing fulfillment.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/fulfillBilling_Create" } } }, "required":false }, "responses":{ "200":{ "description":"The billing was fulfilled successfully." }, "400":{ "description":"The server cannot process the request due to a client error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"The client does not have the correct privileges.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"The request was not authorized.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"This method is not allowed.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"The request could not be processed due to the conflict with the existing state of the resource.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"The system has encountered an internal server error.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"fulFillBilling", "x-internal-id":"createFulfillBilling-post", "x-filename-id":"createfulfillbilling-post" } }, "/bucket":{ "get":{ "tags":[ "Prepay Balance Management/Bucket Balances" ], "summary":"Get Bucket Balances", "description":"Gets the bucket balances that match the specified query criteria.", "operationId":"listBucket", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=name,partyAccount,product.", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Bucket for a base object or @type=BucketOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"product.id", "in":"query", "description":"Retrieves the buckets for the product with the specified ID.", "example":"product.id=0.0.0.1+-service-telco-gsm+67479", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Bucket" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bucket-get", "x-filename-id":"bucket-get" }, "post":{ "tags":[ "Prepay Balance Management/Bucket Balances" ], "summary":"Create a Bucket", "description":"Creates a bucket to store balances.", "operationId":"createBucket", "requestBody":{ "description":"The bucket to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Bucket_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Bucket" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"Bucket", "x-codegen-request-body-name":"bucket", "x-internal-id":"bucket-post", "x-filename-id":"bucket-post" } }, "/bucket/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Bucket Balances" ], "summary":"Get Bucket Balances by ID", "description":"Gets the specified bucket balance.", "operationId":"retrieveBucket", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the bucket object.", "example":"0.0.0.1+-balance_group+106463", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=name,usageType", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Bucket for a base object or @type=BucketOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Bucket" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"bucket-{id}-get", "x-filename-id":"bucket-id-get" } }, "/adjustThreshold/{accountId}":{ "put":{ "tags":[ "Prepay Balance Management/Bucket Balances" ], "summary":"Update a Bucket Threshold for an Account", "description":"Updates a bucket threshold for the specified account.", "operationId":"updateAdjustThreshold", "parameters":[ { "name":"accountId", "in":"path", "description":"The ID or account number of the billing account to adjust the threshold for.", "example":"0.0.0.1+-account+102879", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"The thresholds to be adjusted.

To adjust thresholds, you can specify either a product ID or bucket ID. If you specify both, the thresholds for the bucket will be adjusted. If you specify neither, the default balance group for the account will be used.

You must specify the resource type and provide values for all existing thresholds. Any new thresholds included in the request will be added. Any existing thresholds that are not included in the update request will be removed. For example, if there are three thresholds set for a bucket, but you only list two in the request, the third will be removed.

To remove all thresholds, include an empty thresholds array: [ ].", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustThreshold" } } }, "required":true }, "responses":{ "200":{ "description":"Success" }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"adjustThreshold-{accountId}-put", "x-filename-id":"adjustthreshold-accountid-put" } }, "/adjustBalance":{ "get":{ "tags":[ "Prepay Balance Management/Adjusted Balances" ], "summary":"Get Adjusted Balances", "description":"Gets the adjusted balances that match the query criteria.", "operationId":"listAdjustBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=description,amount", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=AdjustBalance for a base object or @type=AdjustBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"partyAccount.id", "in":"query", "description":"Retrieves the adjustments for the account with the specified ID.", "example":"partyAccount.id=0.0.0.1+-account+70489", "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"Retrieves the adjustment with the specified ID.", "example":"id=0.0.0.1+-item-adjustment+216265", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate", "in":"query", "description":"Retrieves the adjustments with a requestedDate that matches the specified date and time.", "example":"requestedDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gte", "in":"query", "description":"Retrieves the adjustments with a requestedDate that is greater than or equal to the specified date and time.", "example":"requestedDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lte", "in":"query", "description":"Retrieves the adjustments with a requestedDate that is less than or equal to the specified date and time.", "example":"requestedDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gt", "in":"query", "description":"Retrieves the adjustments with a requestedDate that is greater than the specified date and time.", "example":"requestedDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lt", "in":"query", "description":"Retrieves the adjustments with a requestedDate that is less than the specified date and time.", "example":"requestedDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"usageType", "in":"query", "description":"Retrieves adjustments that match the specified usage type. If usageType is not specified, only currency balance adjustments are retrieved.", "example":"Use usageType=monetary to retrieve currency balance adjustments or usageType=other to retrieve non-currency balance adjustments.", "required":false, "schema":{ "type":"string" } }, { "name":"status", "in":"query", "description":"Retrieves the adjustment with the specified item status.", "example":" Use status=completed to retrieve closed currency balance adjustments or status=created to retrieve open currency balance adjustments.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/AdjustBalance" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"adjustBalance-get", "x-filename-id":"adjustbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Adjusted Balances" ], "summary":"Create an Adjusted Balance", "description":"Creates an adjusted balance.", "operationId":"createAdjustBalance", "requestBody":{ "description":"The adjusted balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"adjustBalance", "x-internal-id":"adjustBalance-post", "x-filename-id":"adjustbalance-post" } }, "/adjustBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Adjusted Balances" ], "summary":"Get an Adjusted Balance by ID", "description":"Gets the specified adjusted balance.", "operationId":"retrieveAdjustBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the adjusted balance to get.", "example":"0.0.0.1+-item-adjustment+216265", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=description,amount", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=AdjustBalance for a base object or @type=AdjustBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AdjustBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"adjustBalance-{id}-get", "x-filename-id":"adjustbalance-id-get" } }, "/disputeBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Get a Disputed Balance by ID", "description":"Gets the specified disputed balance.", "operationId":"retrieveDisputeBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=amount,billItem", "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "required":true, "description":"The ID of the disputed balance.", "example":"0.0.0.1+-item-dispute+209114", "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=DisputeBalance for a base object or @type=DisputeBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-{id}-get", "x-filename-id":"disputebalance-id-get" } }, "/disputeBalance":{ "get":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Get Disputed Balances", "description":"Gets the disputed balances that match the specified query criteria.", "operationId":"listDisputeBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=amount,billItem", "required":false, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=DisputeBalance for a base object or @type=DisputeBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "description":"Retrieves the dispute with the specified ID.", "example":"id=0.0.0.1+-item-dispute+209114", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate", "in":"query", "description":"Retrieves disputes with a requestedDate that is equal to the specified date and time.", "example":"requestedDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gte", "in":"query", "description":"Retrieves disputes with a requestedDate that is greater than or equal to the specified date and time.", "example":"requestedDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lte", "in":"query", "description":"Retrieves disputes with a requestedDate that is less than or equal to the specified date and time.", "example":"requestedDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.gt", "in":"query", "description":"Retrieves disputes with a requestedDate that is greater than the specified date and time.", "example":"requestedDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"requestedDate.lt", "in":"query", "description":"Retrieves disputes with a requestedDate that is less than the specified date and time.", "example":"requestedDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"billItem.id", "in":"query", "description":"Retrieves disputes for the bill item with the specified ID.", "example":"billItem.id=0.0.0.1+-item-cycle_forward+108813", "required":false, "schema":{ "type":"string" } }, { "name":"bill.id", "in":"query", "description":"Retrieves disputes for the bill with the specified ID.", "example":"bill.id=0.0.0.1+-bill+105773", "required":false, "schema":{ "type":"string" } }, { "name":"billingCycleSpecification.id", "in":"query", "description":"Retrieves disputes for the billing cycle specification with the specified ID.", "example":"billingCycleSpecification.id=0.0.0.1+-billinfo+107765", "required":false, "schema":{ "type":"string" } }, { "name":"status", "in":"query", "description":"Retrieves disputes by status.", "example":"status=Open", "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate", "in":"query", "description":"Retrieve disputes with a confirmationDate that is equal to the specified date and time.", "example":"confirmationDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.gte", "in":"query", "description":"Retrieves disputes with a confirmationDate that is greater than or equal to the specified date and time.", "example":"confirmationDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.lte", "in":"query", "description":"Retrieves disputes with a confirmationDate that is less than or equal to the specified date and time.", "example":"confirmationDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.gt", "in":"query", "description":"Retrieves disputes with a confirmationDate that is greater than the specified date and time.", "example":"confirmationDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"confirmationDate.lt", "in":"query", "description":"Retrieves disputes with a confirmationDate that is less than the specified date and time.", "example":"confirmationDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"billEvent.id", "in":"query", "description":"Retrieves disputes for the specified bill event.", "example":"billEvent.id=0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+323397156054607117", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-get", "x-filename-id":"disputebalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Disputed Balances" ], "summary":"Create a Disputed Balance", "description":"Creates a disputed balance.", "operationId":"createDisputeBalance", "requestBody":{ "description":"The disputed balance to create.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DisputeBalance_CreateOracle" } } } }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/DisputeBalanceOracle" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"disputeBalance-post", "x-filename-id":"disputebalance-post" } }, "/accumulatedBalance":{ "get":{ "tags":[ "Prepay Balance Management/Accumulated Balances" ], "summary":"Get Accumulated Balances", "description":"Gets accumulated balances that match the query criteria.", "operationId":"listAccumulatedBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=totalBalance,bucket", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "description":"Returns the accumulated balances for the account with the specified ID.", "example":"id=0.0.0.1+-account+102879", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/AccumulatedBalance" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"accumulatedBalance-get", "x-filename-id":"accumulatedbalance-get" } }, "/accumulatedBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Accumulated Balances" ], "summary":"Get an Accumulated Balance by ID", "description":"Gets the specified accumulated balance.", "operationId":"retrieveAccumulatedBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the account to get the accumulated balance for.", "example":"0.0.0.1+-account+102879", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"fields=bucket,name", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=AccumulatedBalance for a base object, or @type=AccumulatedBalanceOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AccumulatedBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"accumulatedBalance-{id}-get", "x-filename-id":"accumulatedbalance-id-get" } }, "/topupBalance":{ "get":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Get Top-up Balances", "description":"Gets top-up balances that match the query criteria.", "operationId":"listTopupBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"isAutoTopup,paymentMethod", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":10, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TopupBalance" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TopupBalance", "x-internal-id":"topupBalance-get", "x-filename-id":"topupbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Create a Top-up Balance", "description":"Creates a top-up balance.", "operationId":"createTopupBalance", "requestBody":{ "description":"The top-up balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"topupBalance", "x-internal-id":"topupBalance-post", "x-filename-id":"topupbalance-post" } }, "/topupBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Top-up Balances" ], "summary":"Get a Top-up Balance by ID", "description":"Gets the specified top-up balance.", "operationId":"retrieveTopupBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the top-up balance to get.", "example":"0.0.0.1+-topup+6442543", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,partyAccount", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TopupBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TopupBalance", "x-internal-id":"topupBalance-{id}-get", "x-filename-id":"topupbalance-id-get" } }, "/transferBalance":{ "get":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Get Transfer Balances", "description":"Gets transfer balances that match the query criteria.", "operationId":"listTransferBalance", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"channel,costOwner", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":0, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "required":false, "schema":{ "type":"integer" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransferBalance" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TransferBalance", "x-internal-id":"transferBalance-get", "x-filename-id":"transferbalance-get" }, "post":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Create a Transfer Balance", "description":"Creates a transfer balance.", "operationId":"createTransferBalance", "requestBody":{ "description":"The transfer balance to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"transferBalance", "x-internal-id":"transferBalance-post", "x-filename-id":"transferbalance-post" } }, "/transferBalance/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Transfer Balances" ], "summary":"Get a Transfer Balance by ID", "description":"Gets the specified transfer balance.", "operationId":"retrieveTransferBalance", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the transfer balance to get.", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"requestor,requestedDate", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/TransferBalance" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-swagger-router-controller":"TransferBalance", "x-internal-id":"transferBalance-{id}-get", "x-filename-id":"transferbalance-id-get" } }, "/balanceAction":{ "get":{ "tags":[ "Prepay Balance Management/Balance Actions" ], "summary":"Get Balance Actions", "description":"Gets balance actions that match the query criteria.", "operationId":"listBalanceAction", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,usageType", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by. For example, use offset=10 to return results 10 and higher.", "example":10, "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return. For example, use limit=10 to return the first 10 results only.", "example":10, "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "in":"query", "description":"The type of object to return. Can be one of the following: TransferBalance, TopupBalance, AdjustBalance, or AdjustBalanceOracle for an extended object.", "example":"TransferBalance", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/BalanceAction" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"balanceAction-get", "x-filename-id":"balanceaction-get" } }, "/balanceAction/{id}":{ "get":{ "tags":[ "Prepay Balance Management/Balance Actions" ], "summary":"Get a Balance Action by ID", "description":"Gets the specified balance action.", "operationId":"retrieveBalanceAction", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the balance action to get.", "example":"0.0.0.1+-event-audit-transfer_balance+3213212", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "example":"impactedBucket,usageType", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "in":"query", "description":"The type of object to return. Can be one of the following: TransferBalance, TopupBalance, AdjustBalance, or AdjustBalanceOracle for an extended object.", "example":"TransferBalance", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/BalanceAction" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"balanceAction-{id}-get", "x-filename-id":"balanceaction-id-get" } }, "/customerBillOnDemand":{ "get":{ "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "summary":"Get On-Demand Customer Bills", "description":"Gets the on-demand customer bills that match the query criteria.", "operationId":"listCustomerBillOnDemand", "parameters":[ { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getCustomerBillOnDemandOffsetExample":{ "summary":"Use offset=10 to return results 10 and higher.", "value":10 } } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getCustomerBillOnDemandLimitExample":{ "summary":"Use limit=10 to return the first 10 results only.", "value":10 } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillOnDemandTypeExample":{ "summary":"Use @type=CustomerBillOnDemand for a base object or @type=CustomerBillOnDemandOracle for an extended object.", "value":"CustomerBillOnDemand" } } }, { "name":"id", "in":"query", "description":"Retrieves the on-demand customer bill for the specified bill ID.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillOnDemandIdExample":{ "summary":"id=0.0.0.1+-bill+106861", "value":"0.0.0.1+-bill+106861" } } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves the on-demand customer bills for the specified account ID.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillOnDemandAccIdExample":{ "summary":"billingAccount.id=0.0.0.1+-account+107117", "value":"0.0.0.1+-account+107117" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomerBillOnDemand" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-get", "x-filename-id":"customerbillondemand-get" }, "post":{ "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "summary":"Create a Customer Bill On Demand", "description":"Creates a bill.", "operationId":"createCustomerBillOnDemand", "requestBody":{ "description":"The bill to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBillOnDemand_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBillOnDemand" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-post", "x-filename-id":"customerbillondemand-post" } }, "/customerBillOnDemand/{id}":{ "get":{ "tags":[ "Customer Bill Management/Customer Bill On Demand" ], "summary":"Get an On-Demand Customer Bill by ID", "description":"Gets the specified on-demand customer bill.", "operationId":"retrieveCustomerBillOnDemand", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the on-demand customer bill to get.", "required":true, "schema":{ "type":"string" }, "examples":{ "customerBillOnDemandIdExample":{ "summary":"0.0.0.1+-bill+106861", "value":"0.0.0.1+-bill+106861" } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "customerBillOndemandTyoeExample":{ "summary":"Use @type=CustomerBillOnDemand for a base object or @type=CustomerBillOnDemandOracle for an extended object.", "value":"CustomerBillOnDemand" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBillOnDemand" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBillOnDemand-{id}-get", "x-filename-id":"customerbillondemand-id-get" } }, "/customerBill":{ "get":{ "tags":[ "Customer Bill Management/Customer Bill" ], "summary":"Get Customer Bills", "description":"Gets the customer bills that match the query criteria.", "operationId":"listCustomerBill", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillFieldsExample":{ "summary":"fields=runType,amountDue", "value":"runType,amountDue" } } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getCustomerBillOffsetExample":{ "summary":"Use offset=10 to return results 10 and higher.", "value":10 } } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getCustomerBillLimitExample":{ "summary":"Use limit=10 to return the first 10 results only.", "value":10 } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillTypeExample":{ "summary":"Use @type=CustomerBill for a base object or @type=CustomerBillOracle for an extended object.", "value":"CustomerBill" } } }, { "name":"id", "in":"query", "description":"Retrieves customer bills for the specified bill ID.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillIdExample":{ "summary":"id=0.0.0.1+-bill+106861", "value":"0.0.0.1+-bill+106861" } } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves customer bills for the specified account ID.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillAccIdExample":{ "summary":"billingAccount.id=0.0.0.1+-account+107117", "value":"0.0.0.1+-account+107117" } } }, { "name":"state", "in":"query", "description":"The state of the bill.", "required":false, "schema":{ "type":"string", "enum":[ "new", "partiallyPaid", "settled", "inProgress" ] }, "examples":{ "getCustomerBillStateExample":{ "summary":"state=inProgress", "value":"inProgress" } } }, { "name":"billNo", "in":"query", "description":"Retrieves customer bills by bill number.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillNoExample":{ "summary":"billNo=B1-28", "value":"B1-28" } } }, { "name":"billNo.like", "in":"query", "description":"Retrieves customer bills that match the specified bill number.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillNoLikeExample":{ "summary":"billNo.like=B1-28", "value":"B1-28" } } }, { "name":"billingPeriod.startDateTime", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that matches the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillStartDExample":{ "summary":"billingPeriod.startDateTime=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.startDateTime.gte", "in":"query", "description":"Retrieves the customer bills with a billing period start date that is greater than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillStartDGteExample":{ "summary":"billingPeriod.startDateTime.gte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.startDateTime.lte", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is less than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillStartDLTEExample":{ "summary":"billingPeriod.startDateTime.lte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.startDateTime.gt", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is greater than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillStartDateGTExample":{ "summary":"billingPeriod.startDateTime.gt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.startDateTime.lt", "in":"query", "description":"Retrieves the customer bills with a billing period start date time that is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillStartDateLtExample":{ "summary":"billingPeriod.startDateTime.lt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.endDateTime", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that matches the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillEndDExample":{ "summary":"billingPeriod.endDateTime=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.endDateTime.gte", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is greater than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillEndDGteExample":{ "summary":"billingPeriod.endDateTime.gte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.endDateTime.lte", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is less than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillEndDateLTEExample":{ "summary":"billingPeriod.endDateTime.lte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.endDateTime.gt", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is greater than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillEndDateGtExample":{ "summary":"billingPeriod.endDateTime.gt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billingPeriod.endDateTime.lt", "in":"query", "description":"Retrieves the customer bills with a billing period end date time that is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillEndDateLtExample":{ "summary":"billingPeriod.endDateTime.lt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"remainingAmount.value", "in":"query", "description":"Retrieves the customer bills with a remaining amount that matches the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillReAmountExample":{ "summary":"remainingAmount.value=30", "value":30 } } }, { "name":"remainingAmount.value.gte", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is greater than or equal to the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillReAmountGteExample":{ "summary":"remainingAmount.value.gte=30", "value":30 } } }, { "name":"remainingAmount.value.lte", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is less than or equal to the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillReAMountLteExample":{ "summary":"remainingAmount.value.lte=30", "value":30 } } }, { "name":"remainingAmount.value.gt", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is greater than the specified value.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillReAmountGtExample":{ "summary":"remainingAmount.value.gt=30", "value":30 } } }, { "name":"remainingAmount.value.lt", "in":"query", "description":"Retrieves the customer bills with a remaining amount that is less than the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillReAmountLtExample":{ "summary":"remainingAmount.value.lt=30", "value":30 } } }, { "name":"remainingAmount.value.like", "in":"query", "description":"Retrieves the customer bills with a wild card in the remaining amount value.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillReAmountLikeExample":{ "summary":"remainingAmount.value.like=3", "value":3 } } }, { "name":"amountDue.value", "in":"query", "description":"Retrieves the customer bills with an amount due that matches the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillAmountExample":{ "summary":"amountDue.value=20", "value":20 } } }, { "name":"amountDue.value.gte", "in":"query", "description":"Retrieves the customer bills with an amount due that is greater than or equal to the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillAmountDueGtExample":{ "summary":"amountDue.value.gte=20", "value":20 } } }, { "name":"amountDue.value.lte", "in":"query", "description":"Retrieves the customer bills with an amount due that is less than or equal to the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillAmountDueLteExample":{ "summary":"amountDue.value.lte=20", "value":20 } } }, { "name":"amountDue.value.gt", "in":"query", "description":"Retrieves the customer bills with an amount due that is greater than the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillAmountDueGtExample":{ "summary":"amountDue.value.gt=20", "value":20 } } }, { "name":"amountDue.value.lt", "in":"query", "description":"Retrieves the customer bills with an amount due value that is less than the specified value.", "required":false, "schema":{ "type":"number", "format":"float" }, "examples":{ "getCustomerBillAmountDueExample":{ "summary":"amountDue.value.lt=20", "value":20 } } }, { "name":"billDate", "in":"query", "description":"Retrieves the customer bills with a billDate that matches the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillBDateExample":{ "summary":"billDate=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billDate.gte", "in":"query", "description":"Retrieves the customer bills with a billDate that is greater than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillBDateGteExample":{ "summary":"billDate.gte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billDate.lte", "in":"query", "description":"Retrieves the customer bills with a billDate that is less than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillBDateLteExample":{ "summary":"billDate.lte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billDate.gt", "in":"query", "description":"Retrieves the customer bills with a billDate that is greater than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillBDateGtExample":{ "summary":"billDate.gt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"billDate.lt", "in":"query", "description":"Retrieves the customer bills with a billDate that is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillBDateLtExample":{ "summary":"billDate.lt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"paymentDueDate", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that matches the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillPaymentDueDateExample":{ "summary":"paymentDueDate=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"paymentDueDate.gte", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is greater than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillPaymentDueDateGteExample":{ "summary":"paymentDueDate.gte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"paymentDueDate.lte", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is less than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillPaymentDueDateLteExample":{ "summary":"paymentDueDate.lte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"paymentDueDate.gt", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is greater than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillPaymentDueDateGTExample":{ "summary":"paymentDueDate.gt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"paymentDueDate.lt", "in":"query", "description":"Retrieves the customer bills with a paymentDueDate that is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillPaymentDueDateLTExample":{ "summary":"paymentDueDate.lt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"lastUpdate", "in":"query", "description":"Retrieves the customer bills whose lastUpdate matches the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillLastUpdateExample":{ "summary":"lastUpdate=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"lastUpdate.gte", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillLastUpdateGteExample":{ "summary":"lastUpdate.gte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"lastUpdate.lte", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is less than or equal to the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillLastUpdateLteExample":{ "summary":"lastUpdate.lte=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"lastUpdate.gt", "in":"query", "description":"Retrieves the customer bills whose lastUpdate is greater than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillLastUpdateGtExample":{ "summary":"lastUpdate.gt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } }, { "name":"lastUpdate.lt", "in":"query", "description":"Retrieves customer bills whose lastUpdate is less than the specified dateTime.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillLastUpdateLtExample":{ "summary":"lastUpdate.lt=2020-01-01T04:00:27-08:00", "value":"2020-01-01T12:00:27.000Z" } } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/CustomerBill" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-get", "x-filename-id":"customerbill-get" } }, "/customerBill/{id}":{ "get":{ "tags":[ "Customer Bill Management/Customer Bill" ], "summary":"Get a Customer Bill by ID", "description":"Gets the specified customer bill.", "operationId":"retrieveCustomerBill", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the customer bill to get.", "required":true, "schema":{ "type":"string" }, "examples":{ "customerBillIdExample":{ "summary":"0.0.0.1+-bill+106861", "value":"0.0.0.1+-bill+106861" } } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "required":false, "schema":{ "type":"string" }, "examples":{ "customerBillFieldsExample":{ "summary":"fields=billDate,paymentDueDate", "value":"billDate,paymentDueDate" } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "customerBillTypeExample":{ "summary":"Use @type=CustomerBill for a base object or @type=CustomerBillOracle for an extended object.", "value":"CustomerBill" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBill" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-{id}-get", "x-filename-id":"customerbill-id-get" }, "patch":{ "tags":[ "Customer Bill Management/Customer Bill" ], "summary":"Update a Customer Bill", "description":"Updates a customer bill. You can update the value of the state property of the bill from InProgress to OnHold or from OnHold to InProgress.", "operationId":"patchCustomerBill", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the customer bill to update.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"The updated customer bill.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBill_Update" } } }, "required":true }, "responses":{ "200":{ "description":"Updated", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/CustomerBill" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not Allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"customerBill-{id}-patch", "x-filename-id":"customerbill-id-patch" } }, "/invoice/{id}":{ "get":{ "tags":[ "Customer Bill Management/Customer Bill Invoice" ], "summary":"Get an Invoice PDF by Bill ID", "description":"Displays the invoice statement PDF for the specified bill ID.", "operationId":"retrieveCustomerBillInvoice", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the bill to get the invoice for.", "required":true, "schema":{ "type":"string" }, "examples":{ "invoiceIdExample":{ "summary":"0.0.0.1+-bill+106861", "value":"0.0.0.1+-bill+106861" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/pdf":{ "schema":{ "type":"string", "description":"An PDF invoice for a bill.", "format":"binary" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"invoice-{id}-get", "x-filename-id":"invoice-id-get" } }, "/appliedCustomerBillingRate":{ "get":{ "tags":[ "Customer Bill Management/Applied Customer Billing Rate" ], "summary":"Get Applied Customer Billing Rates", "description":"Gets the applied customer billing rates that match the query criteria.", "operationId":"listAppliedCustomerBillingRate", "parameters":[ { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "required":false, "schema":{ "type":"string" }, "examples":{ "getAppliedFieldsExample":{ "summary":"fields=bill,billingAccount", "value":"bill,billingAccount" } } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getAppliedOffsetExample":{ "summary":"Use offset=10 to return results 10 and higher.", "value":10 } } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "required":false, "schema":{ "type":"integer" }, "examples":{ "getAppliedLimitExample":{ "summary":"Use limit=10 to return the first 10 results only.", "value":10 } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "getAppliedExample":{ "summary":"Use @type=AppliedCustomerBillingRate for a base object or @type=AppliedCustomerBillingRateOracle for an extended object.", "value":"AppliedCustomerBillingRate" } } }, { "name":"id", "in":"query", "description":"The ID of the applied customer billing rate to get.", "required":false, "schema":{ "type":"string" }, "examples":{ "getAppliedIdExample":{ "summary":"id=0.0.0.1+-item-usage+1", "value":"0.0.0.1+-item-usage+1" } } }, { "name":"billingAccount.id", "in":"query", "description":"Retrieves applied customer billing rates for the specified account ID or account number.", "required":false, "schema":{ "type":"string" }, "examples":{ "getCustomerBillOnDemandAccIdExample":{ "summary":"billingAccount.id=0.0.0.1+-account+107117 or or 0.0.0.1-107117", "value":"0.0.0.1+-account+107117 or 0.0.0.1-107117" } } }, { "name":"bill.id", "in":"query", "description":"Retrieves applied customer billing rates for the specified billId or billNumber.", "required":false, "schema":{ "type":"string" }, "examples":{ "getAppliedBillIdExample":{ "summary":"bill.id=0.0.0.1+-bill+1 or bill.id=B1-10", "value":"0.0.0.1+-bill+1 or B1-10" } } }, { "name":"isBilled", "in":"query", "description":"Retrieves applied customer billing rates with the specified status.", "required":false, "schema":{ "type":"string" }, "examples":{ "getAppliedIsBilledExample":{ "summary":"Use isBilled=true to retrieve open and closed applied customer billing rates or isBilled=false to retrieve pending applied customer billing rates.", "value":true } } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } }, "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "description":"The applied customer billing rates that matched the search criteria.", "items":{ "$ref":"#/components/schemas/AppliedCustomerBillingRate" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"appliedCustomerBillingRate-get", "x-filename-id":"appliedcustomerbillingrate-get" } }, "/appliedCustomerBillingRate/{id}":{ "get":{ "tags":[ "Customer Bill Management/Applied Customer Billing Rate" ], "summary":"Get an Applied Customer Billing Rate by ID", "description":"Gets the specified applied customer billing rate.", "operationId":"retrieveAppliedCustomerBillingRate", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the applied customer billing rate to get.", "required":true, "schema":{ "type":"string" }, "examples":{ "appliedIdExample":{ "summary":"0.0.0.1+-item-usage+1", "value":"0.0.0.1+-item-usage+1" } } }, { "name":"fields", "in":"query", "description":"The list of comma-separated fields to return in the response.", "required":false, "schema":{ "type":"string" }, "examples":{ "appliedFieldsExample":{ "summary":"fields=isBilled,name", "value":"isBilled,name" } } }, { "name":"@type", "in":"query", "description":"The type of object to return.", "required":false, "schema":{ "type":"string" }, "examples":{ "appliedTypeExample":{ "summary":"Use @type=AppliedCustomerBillingRate for a base object or @type=AppliedCustomerBillingRateOracle for an extended object.", "value":"AppliedCustomerBillingRate" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/AppliedCustomerBillingRate" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"appliedCustomerBillingRate-{id}-get", "x-filename-id":"appliedcustomerbillingrate-id-get" } }, "/usage":{ "get":{ "tags":[ "Usage Management" ], "summary":"Get Usage", "operationId":"listUsage", "description":"Gets the usage resource that matches the specified query criteria.", "parameters":[ { "name":"fields", "in":"query", "description":"The list of fields to return in the response.", "example":"fields=type,status", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Usage for a base object, or @type=UsageOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"The ID of the usage to get.", "example":"id=0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+32341474824064940", "schema":{ "type":"string" } }, { "name":"usageDate", "in":"query", "description":"Retrieves the usage with a date that is equal to the specified dateTime.", "example":"usageDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"usageDate.gte", "in":"query", "description":"Retrieves the usage with a date that is greater than or equal to the specified dateTime.", "example":"usageDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"usageDate.lte", "in":"query", "description":"Retrieves the usage with a date that is less than or equal to the specified dateTime.", "example":"usageDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"usageDate.gt", "in":"query", "description":"Retrieves the usage with a date that is greater than the specified dateTime.", "example":"usageDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"usageDate.lt", "in":"query", "description":"Retrieves the usage whose date is less than the specified dateTime.", "example":"usageDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"description.like", "in":"query", "description":"Retrieves the usage whose description is similar to the specified description.", "example":"description.like=Cycle Forward Fees (srvc):Standard GSM Telephony", "required":false, "schema":{ "type":"string" } }, { "name":"description", "in":"query", "description":"Retrieves the usage whose description matches the specified description.", "example":"description=Cycle Forward Fees (srvc):Standard GSM Telephony", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"The usage was returned successfully.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Usage" } } } } }, "400":{ "description":"Request error", "content":{ } }, "500":{ "description":"Unexpected server error", "content":{ } } }, "deprecated":false, "x-internal-id":"usage-get", "x-filename-id":"usage-get" } }, "/usage/{id}":{ "get":{ "tags":[ "Usage Management" ], "summary":"Get Usage by ID", "operationId":"retrieveUsage", "description":"Get the specified usage resource.", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the usage resource to get.", "example":"0.0.0.1+-event-billing-product-fee-cycle-cycle_forward_monthly+32341474824064940", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The list of fields to return in the response.", "example":"fields=description,ratedProductUsage", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Usage for a base object, or @type=UsageOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Usage" } } } }, "400":{ "description":"Request error", "content":{ } }, "404":{ "description":"Not Found", "content":{ } }, "500":{ "description":"Unexpected server error", "content":{ } } }, "x-internal-id":"usage-{id}-get", "x-filename-id":"usage-id-get" } }, "/payment":{ "get":{ "tags":[ "Payment Management/Payment" ], "summary":"Get Payments", "description":"Gets the payments that match the specified query criteria.", "operationId":"listPayment", "parameters":[ { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=paymentDate,account", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Payment for a base object, or @type=PaymentOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"account.id", "in":"query", "description":"Retrieves the payments from the account with the specified ID.", "example":"account.id=0.0.0.1+-account+79731", "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"Retrieves the payment with the specified ID.", "example":"id=0.0.0.1+-item-payment+106589", "schema":{ "type":"string" } }, { "name":"paymentDate", "in":"query", "description":"Retrieves the payments with a paymentDate that matches the specified dateTime.", "example":"paymentDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.gte", "in":"query", "description":"Retrieves the payments with a paymentDate that is greater than or equal to the specified dateTime.", "example":"paymentDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.lte", "in":"query", "description":"Retrieves the payments with a paymentDate that is less than or equal to the specified dateTime.", "example":"paymentDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.gt", "in":"query", "description":"Retrieves the payments with a paymentDate that is greater than the specified dateTime.", "example":"paymentDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"paymentDate.lt", "in":"query", "description":"Retrieves the payments with a paymentDate that is less than the specified dateTime.", "example":"paymentDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"totalAmount.value", "in":"query", "description":"Retrieves the payments with a totalAmount that is equal to the specified amount.", "example":"totalAmount.value=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gte", "in":"query", "description":"Retrieves the payments with a totalAmount that is greater than or equal to the specified amount.", "example":"totalAmount.value.gte=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lte", "in":"query", "description":"Retrieves the payments with a totalAmount that is less than or equal to the specified amount.", "example":"totalAmount.value.lte=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gt", "in":"query", "description":"Retrieves the payments with a totalAmount that is greater than the specified amount.", "example":"totalAmount.value.gt=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lt", "in":"query", "description":"Retrieves the payments with a totalAmount that is less than the specified amount.", "example":"totalAmount.value.lt=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"status", "in":"query", "description":"Retrieves the payments with the specified status.", "example":"The only valid value is status=Unallocated.", "required":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Payment" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"payment-get", "x-filename-id":"payment-get" }, "post":{ "tags":[ "Payment Management/Payment" ], "summary":"Create a Payment", "description":"Creates a payment.", "operationId":"createPayment", "requestBody":{ "description":"The payment to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment_Create" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"payment", "x-internal-id":"payment-post", "x-filename-id":"payment-post" } }, "/payment/{id}":{ "get":{ "tags":[ "Payment Management/Payment" ], "summary":"Get a Payment by ID", "description":"Gets the specified payment.", "operationId":"retrievePayment", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the payment to get.", "example":"0.0.0.1+-item-payment+106589", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=name,paymentItem", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Payment for a base object, or @type=PaymentOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Payment" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"payment-{id}-get", "x-filename-id":"payment-id-get" } }, "/paymentAllocation":{ "post":{ "tags":[ "Payment Management/Payment" ], "summary":"Create a Payment Allocation for a Bill", "description":"Allocates a payment to the specified bill.", "operationId":"createPaymentAllocation", "responses":{ "201":{ "description":"Payment allocation created successfully." }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "requestBody":{ "description":"The payment to allocate.", "required":true, "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/PaymentAllocationRequestRefOracle" } } } }, "x-internal-id":"paymentAllocation-post", "x-filename-id":"paymentallocation-post" } }, "/refund":{ "get":{ "tags":[ "Payment Management/Refund" ], "summary":"Get Refunds", "description":"Gets the refunds that match the specified query criteria.", "operationId":"listRefund", "parameters":[ { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=refundDate,account", "required":false, "schema":{ "type":"string" } }, { "name":"offset", "in":"query", "description":"The number of results to offset the response by.", "example":"Use offset=10 to return results 10 and higher.", "required":false, "schema":{ "type":"integer" } }, { "name":"limit", "in":"query", "description":"The maximum number of results to return.", "example":"Use limit=10 to return the first 10 results only.", "required":false, "schema":{ "type":"integer" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Refund for a base object, or @type=RefundOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } }, { "name":"account.id", "in":"query", "description":"Retrieves the refunds from the account with the specified ID.", "example":"account.id=0.0.0.1+-account+79731", "required":false, "schema":{ "type":"string" } }, { "name":"id", "in":"query", "required":false, "description":"Retrieves the refund with the specified ID.", "example":"id=0.0.0.1+-item-refund+106589", "schema":{ "type":"string" } }, { "name":"refundDate", "in":"query", "description":"Retrieves the refunds with a refundDate that is equal to the specified dateTime.", "example":"refundDate=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.gte", "in":"query", "description":"Retrieves the refunds with a refundDate that is greater than or equal to the specified dateTime.", "example":"refundDate.gte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.lte", "in":"query", "description":"Retrieves the refunds with a refundDate that is less than or equal to the specified dateTime.", "example":"refundDate.lte=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.gt", "in":"query", "description":"Retrieves the refunds with a refundDate that is greater than the specified dateTime.", "example":"refundDate.gt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"refundDate.lt", "in":"query", "description":"Retrieves the refunds with a refundDate that is less than the specified dateTime.", "example":"refundDate.lt=2020-01-01T04:00:27-08:00", "required":false, "schema":{ "type":"string" } }, { "name":"totalAmount.value", "in":"query", "description":"Retrieves the refunds with a totalAmount that is equal to the specified amount.", "example":"totalAmount.value=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gte", "in":"query", "description":"Retrieves the refunds with a totalAmount that is greater than or equal to the specified amount.", "example":"totalAmount.value.gte=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lte", "in":"query", "description":"Retrieves the refunds with a totalAmount is less than or equal to the specified amount.", "example":"totalAmount.value.lte=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.gt", "in":"query", "description":"Retrieves the refunds with a totalAmount that is greater than the specified amount.", "example":"totalAmount.value.gt=40", "required":false, "schema":{ "type":"number", "format":"float" } }, { "name":"totalAmount.value.lt", "in":"query", "description":"Retrieves the refunds with a totalAmount that is less than the specified amount.", "example":"totalAmount.value.lt=40", "required":false, "schema":{ "type":"number", "format":"float" } } ], "responses":{ "200":{ "description":"Success", "headers":{ "X-Total-Count":{ "description":"The total number of items that matched the criteria.", "schema":{ "type":"integer" } }, "X-Result-Count":{ "description":"The number of items returned in the response body.", "schema":{ "type":"integer" } } }, "content":{ "application/json;charset=utf-8":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Refund" } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"refund-get", "x-filename-id":"refund-get" }, "post":{ "tags":[ "Payment Management/Refund" ], "summary":"Create a Refund", "description":"Creates a refund.", "operationId":"createRefund", "requestBody":{ "description":"The refund to create.", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/RefundCreate" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Refund" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-codegen-request-body-name":"refund", "x-internal-id":"refund-post", "x-filename-id":"refund-post" } }, "/refund/{id}":{ "get":{ "tags":[ "Payment Management/Refund" ], "summary":"Get a Refund by ID", "description":"Gets the specified refund.", "operationId":"retrieveRefund", "parameters":[ { "name":"id", "in":"path", "description":"The ID of the refund to get.", "example":"0.0.0.1+-item-refund+106589", "required":true, "schema":{ "type":"string" } }, { "name":"fields", "in":"query", "description":"The comma-separated list of fields to return in the response.", "example":"fields=name,payment", "required":false, "schema":{ "type":"string" } }, { "name":"@type", "description":"The type of object to return.", "example":"Use @type=Refund for a base object, or @type=RefundOracle for an extended object.", "required":false, "in":"query", "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Refund" } } } }, "400":{ "description":"Bad Request", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "401":{ "description":"Unauthorized", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "403":{ "description":"Forbidden", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "404":{ "description":"Not Found", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "405":{ "description":"Method Not allowed", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "409":{ "description":"Conflict", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } }, "500":{ "description":"Internal Server Error", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/Error" } } } } }, "x-internal-id":"refund-{id}-get", "x-filename-id":"refund-id-get" } } }, "components":{ "schemas":{ "Account":{ "required":[ "name" ], "type":"object", "title":"Account", "description":"A generic account containing properties common to other sub-types of account such as PartyAccount and FinancialAccount.", "properties":{ "id":{ "type":"string", "title":"Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Account Href", "description":"The account's href." }, "accountType":{ "type":"string", "title":"Accounting Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Account Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Account Name", "description":"The account's name." }, "state":{ "type":"string", "title":"Account State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "relatedParty":{ "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "AccountBalance":{ "required":[ "amount", "balanceType", "validFor" ], "type":"object", "title":"Account Balance", "description":"A balance associated with an account.", "properties":{ "balanceType":{ "type":"string", "title":"Balance Type", "description":"The balance's type. For example, deposit, disputed, loyalty, or receivable." }, "amount":{ "description":"The balance's amount.", "$ref":"#/components/schemas/Money" }, "validFor":{ "description":"The time period for which the balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "AccountRef":{ "required":[ "id" ], "type":"object", "title":"Account Ref", "properties":{ "id":{ "type":"string", "title":"Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Account Href", "description":"The account's href." }, "description":{ "type":"string", "title":"Account Description", "description":"The account's description." }, "name":{ "type":"string", "title":"Account Name", "description":"The account's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"An account's reference." }, "AccountRelationship":{ "required":[ "relationshipType", "validFor" ], "type":"object", "title":"Account Relationship", "properties":{ "relationshipType":{ "type":"string", "title":"Relationship Type", "description":"The type of relationship." }, "account":{ "description":"The account in the relationship.", "$ref":"#/components/schemas/AccountRef" }, "validFor":{ "description":"The time period for which the relationship is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The relationship between accounts." }, "AccountTaxExemption":{ "required":[ "issuingJurisdiction", "validFor" ], "type":"object", "title":"Account Tax Exemption", "properties":{ "certificateNumber":{ "type":"string", "title":"Certificate Number", "description":"The certificate or ID number of a document that shows proof of tax exemption." }, "issuingJurisdiction":{ "type":"string", "title":"Issuing Jurisdiction", "description":"The taxation jurisdiction for the tax from which that the account is exempt." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the tax exemption." }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The account's proof of exemption from a tax." }, "BillFormat":{ "required":[ "name" ], "type":"object", "title":"Bill Format", "properties":{ "id":{ "type":"string", "title":"Bill Format ID", "description":"The bill format's ID." }, "href":{ "type":"string", "title":"Bill Format Href", "description":"The bill format's href." }, "description":{ "type":"string", "title":"Bill Format Description", "description":"The bill format's description." }, "name":{ "type":"string", "title":"Bill Format Name", "description":"The bill format's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A bill's format." }, "BillFormat_Create":{ "required":[ "name" ], "type":"object", "title":"Bill Format Create", "properties":{ "description":{ "type":"string", "title":"Bill Format Description", "description":"The bill format's description." }, "name":{ "type":"string", "title":"Bill Format Name", "description":"The bill format's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A bill format, used in bill format creation requests. The id and href aren't used in the creation request." }, "BillFormat_Update":{ "required":[ "name" ], "type":"object", "title":"Bill Format Update", "properties":{ "description":{ "type":"string", "title":"Bill Format Description", "description":"The bill format's description." }, "name":{ "type":"string", "title":"Bill Format Name", "description":"The bill format's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A bill format, used in bill format update requests. The id and href properties aren't used in the update request." }, "BillFormatRef":{ "required":[ "id" ], "type":"object", "title":"Bill Format Ref", "properties":{ "id":{ "type":"string", "title":"Bill Format ID", "description":"The bill format's ID." }, "href":{ "type":"string", "title":"Bill Format Href", "description":"The bill format's href." }, "name":{ "type":"string", "title":"Bill Format Name", "description":"The bill format's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A bill format reference." }, "BillFormatRefOrValue":{ "required":[ "isRef", "name" ], "type":"object", "title":"Bill Format Ref Or Value", "properties":{ "id":{ "type":"string", "title":"Bill Format ID", "description":"The bill format's ID." }, "href":{ "type":"string", "title":"Bill Format Href", "description":"The bill format's href." }, "description":{ "type":"string", "title":"Bill Format Description", "description":"The bill format's description." }, "isRef":{ "type":"boolean", "title":"Is Bill Format Ref", "description":"Whether the bill format is a reference (true or a value (false).", "default":true }, "name":{ "type":"string", "title":"Bill Format Name", "description":"The bill format's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A link to a bill format or a bill format reference." }, "BillPresentationMedia":{ "required":[ "name" ], "type":"object", "title":"Bill Presentation Media", "properties":{ "id":{ "type":"string", "title":"Bill Presentation ID", "description":"The bill presentation's ID." }, "href":{ "type":"string", "title":"Bill Presentation Href", "description":"The bill presentation's href." }, "description":{ "type":"string", "title":"Bill Presentation Description", "description":"The bill presentation's description." }, "name":{ "type":"string", "title":"Bill Presentation Name", "description":"The bill presentation's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The way a bill is sent. For example, by post, email, or a web page." }, "BillPresentationMedia_Create":{ "required":[ "name" ], "type":"object", "title":"Bill Presentation Media Create", "properties":{ "description":{ "type":"string", "title":"Bill Presentation Description", "description":"The bill presentation's description." }, "name":{ "type":"string", "title":"Bill Presentation Name", "description":"The bill presentation's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The way a bill is sent, used in bill presentation media create requests. The id and href properties aren't used in the create request." }, "BillPresentationMedia_Update":{ "required":[ "name" ], "type":"object", "title":"Bill Presentation Media Update", "properties":{ "description":{ "type":"string", "title":"Bill Presentation Description", "description":"The bill presentation's description." }, "name":{ "type":"string", "title":"Bill Presentation Name", "description":"The bill presentation's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The way a bill is sent, used in bill presentation media update requests. The id and href properties aren't used in the update request." }, "BillPresentationMediaRef":{ "required":[ "id" ], "type":"object", "title":"Bill Presentation Media Ref", "properties":{ "id":{ "type":"string", "title":"Bill Presentation ID", "description":"The bill presentation's ID." }, "href":{ "type":"string", "title":"Bill Presentation Href", "description":"The bill presentation's href." }, "name":{ "type":"string", "title":"Bill Presentation Name", "description":"The bill presentation's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A bill presentation media reference." }, "BillPresentationMediaRefOrValue":{ "required":[ "isRef", "name" ], "type":"object", "title":"Bill Presentation Media Ref Or Value", "properties":{ "id":{ "type":"string", "title":"Bill Presentation ID", "description":"The bill presentation's ID." }, "href":{ "type":"string", "title":"Bill Presentation Href", "description":"The bill presentation's href." }, "description":{ "type":"string", "title":"Bill Presentation Description", "description":"The bill presentation's description." }, "isRef":{ "type":"boolean", "title":"Is Bill Presentation Ref", "description":"Whether the bill presentation is a reference (true) or a value (false).", "default":true }, "name":{ "type":"string", "title":"Bill Presentation Name", "description":"The bill presentation's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A link to a bill presentation media or bill presentation media reference." }, "BillStructure":{ "type":"object", "title":"Bill Structure", "properties":{ "cycleSpecification":{ "description":"A billing cycle specification associated with the bill structure.", "$ref":"#/components/schemas/BillingCycleSpecificationRefOrValue" }, "format":{ "description":"A bill format associated with the bill structure.", "$ref":"#/components/schemas/BillFormatRefOrValue" }, "presentationMedia":{ "type":"array", "description":"The bill presentation media associated with the bill structure.", "items":{ "$ref":"#/components/schemas/BillPresentationMediaRefOrValue" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The structure of a bill, for associating billing cycle specifications, formats, and presentation media." }, "BillingAccount":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Billing Account", "properties":{ "id":{ "type":"string", "title":"Billing Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Billing Account Href", "description":"The account's href." }, "accountType":{ "type":"string", "title":"Accounting Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Billing Account Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Billing Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for billing." }, "BillingAccount_Create":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Billing Account Create", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Billing Account Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Billing Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for billing, used in billing account create requests. The id and href properties aren't used in the create request." }, "BillingAccount_Update":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Billing Account Update", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Billing Account Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Billing Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for billing, used in billing account update requests. The id, href, and accountBalance properties aren't used in the update request." }, "BillingCycleSpecification":{ "required":[ "name", "id", "href" ], "type":"object", "title":"Billing Cycle Specification", "properties":{ "id":{ "type":"string", "title":"Billing Cycle Specification ID", "description":"The billing cycle specification's ID." }, "href":{ "type":"string", "title":"Billing Cycle Specification Href", "description":"The billing cycle specification's href." }, "billingDateShift":{ "type":"integer", "title":"Billing Date Shift", "description":"The number of days from the start of the billing period by which to offset the billing date." }, "billingPeriod":{ "type":"string", "title":"Billing Period", "description":"The length of the billing period. For example, week, month, quarter, year." }, "chargeDateOffset":{ "type":"integer", "title":"Charge Date Offset", "description":"The number of days from the start of the billing period by which to offset the charges that appear on a bill." }, "creditDateOffset":{ "type":"integer", "title":"Credit Date Offset", "description":"The number of days from the start of the billing period by which to offset the credits that appear on a bill." }, "description":{ "type":"string", "title":"Billing Cycle Specification Description", "description":"The billing cycle specification's description." }, "frequency":{ "type":"string", "title":"Frequency", "description":"The billing frequency. For example, monthly." }, "mailingDateOffset":{ "type":"integer", "title":"Mailing Date Offset", "description":"The number of days from the start of the billing period by which to offset the date the bill is mailed." }, "name":{ "type":"string", "title":"Billing Cycle Specification Name", "description":"The billing cycle specification's name." }, "paymentDueDateOffset":{ "type":"integer", "title":"Payment Due Date Offset", "description":"The number of days from the start of the billing period by which to offset the payment's due date." }, "validFor":{ "description":"The time period for which the billing cycle specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A billing cycle specification, which specifies billing cycle details." }, "BillingCycleSpecification_Create":{ "required":[ "name" ], "type":"object", "title":"Billing Cycle Specification Create", "properties":{ "billingDateShift":{ "type":"integer", "title":"Billing Date Shift", "description":"The number of days from the start of the billing period by which to offset the billing date." }, "billingPeriod":{ "type":"string", "title":"Billing Period", "description":"The length of the billing period. For example, week, month, quarter, year." }, "chargeDateOffset":{ "type":"integer", "title":"Charge Date Offset", "description":"The number of days from the start of the billing period by which to offset the charges that appear on a bill." }, "creditDateOffset":{ "type":"integer", "title":"Credit Date Offset", "description":"The number of days from the start of the billing period by which to offset the credits that appear on a bill." }, "description":{ "type":"string", "title":"Billing Cycle Specification Description", "description":"The billing cycle specification's description." }, "frequency":{ "type":"string", "title":"Frequency", "description":"The billing frequency. For example, monthly." }, "mailingDateOffset":{ "type":"integer", "title":"Mailing Date Offset", "description":"The number of days from the start of the billing period by which to offset the date the bill is mailed." }, "name":{ "type":"string", "title":"Billing Cycle Specification Name", "description":"The billing cycle specification's name." }, "paymentDueDateOffset":{ "type":"integer", "title":"Payment Due Date Offset", "description":"The number of days from the start of the billing period by which to offset the payment's due date." }, "validFor":{ "description":"The time period for which the billing cycle specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A billing cycle specification, which specifies billing cycle details. Used in billing cycle specification create requests. The id and href properties aren't used in the create request." }, "BillingCycleSpecification_Update":{ "required":[ "name" ], "type":"object", "title":"Billing Cycle Specification Update", "properties":{ "billingDateShift":{ "type":"integer", "title":"Billing Date Shift", "description":"The number of days from the start of the billing period by which to offset the billing date." }, "billingPeriod":{ "type":"string", "title":"Billing Period", "description":"The length of the billing period. For example, week, month, quarter, year." }, "chargeDateOffset":{ "type":"integer", "title":"Charge Date Offset", "description":"The number of days from the start of the billing period by which to offset the charges that appear on a bill." }, "creditDateOffset":{ "type":"integer", "title":"Credit Date Offset", "description":"The number of days from the start of the billing period by which to offset the credits that appear on a bill." }, "description":{ "type":"string", "title":"Billing Cycle Specification Description", "description":"The billing cycle specification's description." }, "frequency":{ "type":"string", "title":"Frequency", "description":"The billing frequency. For example, monthly." }, "mailingDateOffset":{ "type":"integer", "title":"Mailing Date Offset", "description":"The number of days from the start of the billing period by which to offset the date the bill is mailed." }, "name":{ "type":"string", "title":"Billing Cycle Specification Name", "description":"The billing cycle specification's name." }, "paymentDueDateOffset":{ "type":"integer", "title":"Payment Due Date Offset", "description":"The number of days from the start of the billing period by which to offset the payment's due date." }, "validFor":{ "description":"The time period for which the billing cycle specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A billing cycle specification, which specifies billing cycle details. Used in billing cycle specification update requests. The id and href properties aren't used in the update request." }, "BillingCycleSpecificationRef":{ "required":[ "id" ], "type":"object", "title":"Billing Cycle Specification Ref", "properties":{ "id":{ "type":"string", "title":"Billing Cycle Specification ID", "description":"The billing cycle specification's ID." }, "href":{ "type":"string", "title":"Billing Cycle Specification Href", "description":"The billing cycle specification's href." }, "dateShift":{ "type":"integer", "title":"Date Offset", "description":"The number of days from the start of the billing period by which to offset the billing date." }, "frequency":{ "type":"string", "title":"Frequency", "description":"The billing frequency. For example, monthly." }, "name":{ "type":"string", "title":"Billing Cycle Specification Name", "description":"The billing cycle specification's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A billing cycle specification reference." }, "BillingCycleSpecificationRefOrValue":{ "required":[ "isRef", "name" ], "type":"object", "title":"Billing Cycle Specification Ref Or Value", "properties":{ "id":{ "type":"string", "title":"Billing Cycle Specification ID", "description":"The billing cycle specification's ID." }, "href":{ "type":"string", "title":"Billing Cycle Specification Href", "description":"The billing cycle specification's href." }, "billingDateShift":{ "type":"integer", "title":"Billing Date Shift", "description":"The number of days from the start of the billing period by which to offset the billing date." }, "billingPeriod":{ "type":"string", "title":"Billing Period", "description":"The length of the billing period. For example, week, month, quarter, year." }, "chargeDateOffset":{ "type":"integer", "title":"Charge Date Offset", "description":"The number of days from the start of the billing period by which to offset the charges that appear on a bill." }, "creditDateOffset":{ "type":"integer", "title":"Credit Date Offset", "description":"The number of days from the start of the billing period by which to offset the credits that appear on a bill." }, "description":{ "type":"string", "title":"Billing Cycle Specification Description", "description":"The billing cycle specification's description." }, "frequency":{ "type":"string", "title":"Frequency", "description":"The billing frequency. For example, monthly." }, "isRef":{ "type":"boolean", "title":"Is Billing Cycle Specification Ref", "description":"Whether the billing cycle specification is a reference (true) or a value (false).", "default":true }, "mailingDateOffset":{ "type":"integer", "title":"Mailing Date Offset", "description":"The number of days from the start of the billing period by which to offset the date the bill is mailed." }, "name":{ "type":"string", "title":"Billing Cycle Specification Name", "description":"The billing cycle specification's name." }, "paymentDueDateOffset":{ "type":"integer", "title":"Payment Due Date Offset", "description":"The number of days from the start of the billing period by which to offset the payment's due date." }, "validFor":{ "description":"The time period for which the billing cycle specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A link to a billing cycle specification or billing cycle specification reference." }, "Contact":{ "required":[ "contactType", "validFor" ], "type":"object", "title":"Contact", "properties":{ "contactName":{ "type":"string", "title":"Contact Name", "description":"The contact's name." }, "contactType":{ "type":"string", "title":"Contact Type", "description":"The type of contact. For example, primary or secondary." }, "partyRoleType":{ "type":"string", "title":"Party Role Type", "description":"The role of the party linked to the contact. For example, an account manager." }, "contactMedium":{ "type":"array", "description":"The ways to reach the contact.", "items":{ "$ref":"#/components/schemas/ContactMedium" } }, "relatedParty":{ "description":"The party related to the contact.", "$ref":"#/components/schemas/RelatedParty" }, "validFor":{ "description":"The time period for which the contact is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An individual or an organization used as a contact point for an account." }, "ContactMedium":{ "type":"object", "title":"Contact Medium", "properties":{ "mediumType":{ "type":"string", "title":"Medium Type", "description":"The type of the contact medium. For example, email, phone, postal address." }, "preferred":{ "type":"boolean", "title":"Preferred Contact", "description":"Whether this is the preferred contact medium for the account (true) or not (false)." }, "characteristic":{ "description":"The details of the contact medium. For example, the email or postal address details.", "$ref":"#/components/schemas/MediumCharacteristic" }, "validFor":{ "description":"The time period for which the contact is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The way to reach a contact." }, "EntityRef":{ "required":[ "id" ], "type":"object", "title":"Entity Ref", "properties":{ "id":{ "type":"string", "title":"Entity ID", "description":"The entity's ID." }, "href":{ "type":"string", "title":"Entity Href", "description":"The entity's href." }, "name":{ "type":"string", "title":"Entity Name", "description":"The entity's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"An entity reference schema." }, "FinancialAccount":{ "required":[ "name" ], "type":"object", "title":"Financial Account", "properties":{ "id":{ "type":"string", "title":"Financial Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Financial Account Href", "description":"The account's href." }, "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Financial Account Name", "description":"The account's name." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "relatedParty":{ "type":"array", "description":"Parties related to the account.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An accounts receivable or accounts payable account used to track money owed in exchange for goods and services. Aggregates amounts from one or more billing or settlement accounts." }, "FinancialAccount_Create":{ "required":[ "name" ], "type":"object", "title":"Financial Account Create", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Financial Account Name", "description":"The account's name." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "relatedParty":{ "type":"array", "description":"Parties related to the account.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An accounts receivable or accounts payable account used to track money owed in exchange for goods and services. Used in financial account create requests. The id and href properties aren't used in the create request." }, "FinancialAccount_Update":{ "required":[ "name" ], "type":"object", "title":"Financial Account Update", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "name":{ "type":"string", "title":"Financial Account Name", "description":"The account's name." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "relatedParty":{ "type":"array", "description":"Parties related to the account.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An accounts receivable or accounts payable account used to track money owed in exchange for goods and services. Used in financial account create requests. The id, href, and lastModified properties aren't used in the create request." }, "FinancialAccountRef":{ "required":[ "id" ], "type":"object", "title":"Financial Account Ref", "properties":{ "id":{ "type":"string", "title":"Financial Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Financial Account Href", "description":"The account's href." }, "name":{ "type":"string", "title":"Financial Account Name", "description":"The account's name." }, "accountBalance":{ "description":"The account's balance.", "$ref":"#/components/schemas/AccountBalance" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A financial account reference." }, "MediumCharacteristic":{ "type":"object", "title":"Medium Characteristic", "properties":{ "city":{ "type":"string", "title":"City", "description":"For a contact's postal address, the city." }, "contactType":{ "type":"string", "title":"Contact Type", "description":"The type of contact. For example, for a phone number, mobile or home. For a postal address, shipping or installation." }, "country":{ "type":"string", "title":"Country", "description":"For a contact's postal address, the country." }, "emailAddress":{ "type":"string", "title":"Email Address", "description":"A contact's email address." }, "faxNumber":{ "type":"string", "title":"Fax Number", "description":"A contact's fax number." }, "phoneNumber":{ "type":"string", "title":"Phone Number", "description":"A contact's primary phone number." }, "postCode":{ "type":"string", "title":"Post Code", "description":"A contact's postal or ZIP code" }, "socialNetworkId":{ "type":"string", "title":"Social Network ID", "description":"A contact's social network ID or username." }, "stateOrProvince":{ "type":"string", "title":"State Or Province", "description":"For a contact's postal address, the State or province." }, "street1":{ "type":"string", "title":"Street", "description":"For a contact's postal address, the street number and name." }, "street2":{ "type":"string", "title":"Street", "description":"For a contact's postal address, a second line for street information." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The characteristics that define a contact medium." }, "Money":{ "type":"object", "title":"Money", "properties":{ "unit":{ "type":"string", "title":"Currency", "description":"An ISO 4217 three letter currency code." }, "value":{ "type":"number", "title":"Amount", "description":"A positive floating point number.", "format":"float" } }, "description":"An amount of money." }, "PartyAccount":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Party Account", "properties":{ "id":{ "type":"string", "title":"Party Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Party Account Href", "description":"The account's href." }, "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An organization or individual's account used for billing or for settlement purposes." }, "PartyAccount_Create":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Party Account Create", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"string", "description":"The account's tax exemptions." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An organization or individual's account used for billing or for settlement purposes. Used in party account create requests. The id and href properties aren't used in the create request." }, "PartyAccount_Update":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Party Account Update", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"string", "description":"The account's tax exemptions." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An organization or individual's account used for billing or for settlement purposes. Used in party account update requests. The id, href, and accountBalance properties aren't used in the update request." }, "PaymentMethodRef":{ "required":[ "id" ], "type":"object", "title":"Payment Method Ref", "properties":{ "id":{ "type":"string", "title":"Payment Method ID", "description":"The payment method's ID." }, "href":{ "type":"string", "title":"Payment Method Href", "description":"The payment method's href." }, "name":{ "type":"string", "title":"Payment Method Name", "description":"The payment method's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A payment method reference." }, "PaymentPlan":{ "type":"object", "title":"Payment Plan", "properties":{ "numberOfPayments":{ "type":"integer", "title":"Number Of Payments", "description":"The number of payments used to make an overall payment." }, "paymentFrequency":{ "type":"string", "title":"Payment Frequency", "description":"The payment's frequency. For example, monthly, bimonthly." }, "planType":{ "type":"string", "title":"Plan Type", "description":"The payment plan's type." }, "priority":{ "type":"integer", "title":"Plan Priority", "description":"The payment plan's priority." }, "status":{ "type":"string", "title":"Status", "description":"The payment plan's status. For example, effective or ineffective." }, "paymentMethod":{ "description":"The payment method used by the payment plan.", "$ref":"#/components/schemas/PaymentMethodRef" }, "totalAmount":{ "description":"The payment plan's total amount.", "$ref":"#/components/schemas/Money" }, "validFor":{ "description":"The time period for which the payment plan is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment plan, where a party spreads an overall payment into multiple smaller payments." }, "RelatedParty":{ "required":[ "@referredType", "id", "name" ], "type":"object", "title":"Related Party", "properties":{ "id":{ "type":"string", "title":"Related Party ID", "description":"The related party's ID." }, "href":{ "type":"string", "title":"Related Party Href", "description":"The related party's href." }, "name":{ "type":"string", "title":"Related Party Name", "description":"The related party's name." }, "role":{ "type":"string", "title":"Related Party Role", "description":"The related party's role." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A party related to another object." }, "SettlementAccount":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Settlement Account", "properties":{ "id":{ "type":"string", "title":"Settlement Account ID", "description":"The account's ID." }, "href":{ "type":"string", "title":"Settlement Href", "description":"The account's href." }, "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for settlements." }, "SettlementAccount_Create":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Settlement Account Create", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountBalance":{ "type":"array", "description":"The account's balances.", "items":{ "$ref":"#/components/schemas/AccountBalance" } }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for settlements. Used in settlement account create requests. The id and href properties aren't used in the create request." }, "SettlementAccount_Update":{ "required":[ "name", "relatedParty" ], "type":"object", "title":"Settlement Account Update", "properties":{ "accountType":{ "type":"string", "title":"Account Type", "description":"The type of account. For example, individual or joint." }, "description":{ "type":"string", "title":"Description", "description":"The account's description." }, "lastModified":{ "type":"string", "title":"Last Modified Date", "description":"The date that the account was last modified.", "format":"date-time" }, "name":{ "type":"string", "title":"Party Account Name", "description":"The account's name." }, "paymentStatus":{ "type":"string", "title":"Payment Status", "description":"The overall status of the account's payments. For example, due, paid, or in arrears." }, "state":{ "type":"string", "title":"State", "description":"The account's lifecycle state. For example, Active, Closed, or Suspended." }, "accountRelationship":{ "type":"array", "description":"The account's relationships.", "items":{ "$ref":"#/components/schemas/AccountRelationship" } }, "billStructure":{ "description":"The account's bill structure.", "$ref":"#/components/schemas/BillStructure" }, "contact":{ "type":"array", "description":"The account's contacts.", "items":{ "$ref":"#/components/schemas/Contact" } }, "creditLimit":{ "description":"The account's credit limit.", "$ref":"#/components/schemas/Money" }, "defaultPaymentMethod":{ "description":"The account's default payment method.", "$ref":"#/components/schemas/PaymentMethodRef" }, "financialAccount":{ "description":"The financial account associated with the account.", "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentPlan":{ "type":"array", "description":"The account's payment plans.", "items":{ "$ref":"#/components/schemas/PaymentPlan" } }, "relatedParty":{ "minItems":1, "type":"array", "description":"The account's related parties.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "taxExemption":{ "type":"array", "description":"The account's tax exemptions.", "items":{ "$ref":"#/components/schemas/AccountTaxExemption" } }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An account used for settlements. Used in settlement account update requests. The id, href, and accountBalance properties aren't used in the update request." }, "TimePeriod":{ "type":"object", "title":"Time Period", "properties":{ "endDateTime":{ "type":"string", "title":"End Time Period", "description":"The end of the time period in IETC-RFC-3339 format.", "format":"date-time" }, "startDateTime":{ "type":"string", "title":"Start Time Period", "description":"The start of the time period in IETC-RFC-3339 format. If you specify this, you must also specify endDateTime.", "format":"date-time" } }, "description":"A period of time. You can specify only endDateTime or both endDateTime and startDateTime." }, "EventSubscription":{ "required":[ "callback", "id" ], "type":"object", "title":"Event Subscription", "properties":{ "id":{ "type":"string", "title":"Event ID", "description":"The event subscription listener's ID." }, "callback":{ "type":"string", "title":"Event Callback", "description":"The callback being registered." }, "query":{ "type":"string", "title":"Event Query", "description":"Additional data being sent." } }, "description":"The endpoint address to which a service instance sends notifications." }, "EventSubscriptionInput":{ "required":[ "callback" ], "type":"object", "title":"Event Subscription Input", "properties":{ "callback":{ "type":"string", "title":"Event Callback", "description":"The callback being registered." }, "query":{ "type":"string", "title":"Event Query", "description":"Additional data being sent." } }, "description":"The input for the event subscription notification message." }, "PartyAccountAttributeValueChangeEvent":{ "type":"object", "title":"Party Account Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The time the event occurred.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "payload":{ "description":"The event payload.", "$ref":"#/components/schemas/PartyAccountAttributeValueChangeEventPayload" } }, "description":"An event for changing a party account's attribute." }, "PartyAccountAttributeValueChangeEventPayload":{ "type":"object", "title":"Party Account Attribute Value Change Event Payload", "properties":{ "partyAccount":{ "description":"The party account with a changed attribute.", "$ref":"#/components/schemas/PartyAccount" } }, "description":"The payload for PartyAccountAttributeValueChangeEvent." }, "PartyAccountStateChangeEvent":{ "type":"object", "title":"Party Account State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/PartyAccountStateChangeEventPayload" } }, "description":"An event for changing the state of a party account." }, "PartyAccountStateChangeEventPayload":{ "type":"object", "title":"Party Account State Change Event Payload", "properties":{ "partyAccount":{ "description":"The party account with a changed state.", "$ref":"#/components/schemas/PartyAccount" } }, "description":"The payload for PartyAccountStateChangeEvent." }, "BillingAccountAttributeValueChangeEvent":{ "type":"object", "title":"Billing Account Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/BillingAccountAttributeValueChangeEventPayload" } }, "description":"An event for changing a billing account's attribute." }, "BillingAccountAttributeValueChangeEventPayload":{ "type":"object", "title":"Billing Account Attribute Value Change Event Payload", "properties":{ "billingAccount":{ "description":"The settlement account with a changed attribute.", "$ref":"#/components/schemas/BillingAccount" } }, "description":"The payload for BillingAccountAttributeValueChangeEvent." }, "BillingAccountStateChangeEvent":{ "type":"object", "title":"Billing Account State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/BillingAccountStateChangeEventPayload" } }, "description":"An event for changing the state of a billing account." }, "BillingAccountStateChangeEventPayload":{ "type":"object", "title":"Billing Account State Change Event Payload", "properties":{ "billingAccount":{ "description":"The billing account with a changed state.", "$ref":"#/components/schemas/BillingAccount" } }, "description":"The payload for BillingAccountStateChangeEvent." }, "SettlementAccountAttributeValueChangeEvent":{ "type":"object", "title":"Settlement Account Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/SettlementAccountAttributeValueChangeEventPayload" } }, "description":"An event for changing a settlement account's attribute." }, "SettlementAccountAttributeValueChangeEventPayload":{ "type":"object", "title":"Settlement Account Attribute Value Change Event Payload", "properties":{ "settlementAccount":{ "description":"The settlement account with a changed attribute.", "$ref":"#/components/schemas/SettlementAccount" } }, "description":"The payload for SettlementAccountAttributeValueChangeEvent." }, "SettlementAccountStateChangeEvent":{ "type":"object", "title":"Settlement Account State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/SettlementAccountStateChangeEventPayload" } }, "description":"An event for changing the state of a settlement account." }, "SettlementAccountStateChangeEventPayload":{ "type":"object", "title":"Settlement Account State Change Event Payload", "properties":{ "settlementAccount":{ "description":"The settlement account with a changed state.", "$ref":"#/components/schemas/SettlementAccount" } }, "description":"The payload for SettlementAccountStateChangeEvent." }, "FinancialAccountCreateEvent":{ "type":"object", "title":"Financial Account Create Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/FinancialAccountCreateEventPayload" } }, "description":"An event for creating a financial account." }, "FinancialAccountCreateEventPayload":{ "type":"object", "title":"Financial Account Create Event Payload", "properties":{ "financialAccount":{ "description":"The financial account to create.", "$ref":"#/components/schemas/FinancialAccount" } }, "description":"The payload for FinancialAccountCreateEvent." }, "FinancialAccountAttributeValueChangeEvent":{ "type":"object", "title":"Financial Account Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/FinancialAccountAttributeValueChangeEventPayload" } }, "description":"An event for changing a financial account's attribute." }, "FinancialAccountAttributeValueChangeEventPayload":{ "type":"object", "title":"Financial Account Attribute Value Change Event Payload", "properties":{ "financialAccount":{ "description":"The financial account with a changed attribute.", "$ref":"#/components/schemas/FinancialAccount" } }, "description":"The payload for FinancialAccountAttributeValueChangeEvent." }, "FinancialAccountStateChangeEvent":{ "type":"object", "title":"Financial Account State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/FinancialAccountStateChangeEventPayload" } }, "description":"An event for changing a financial account's state." }, "FinancialAccountStateChangeEventPayload":{ "type":"object", "title":"Financial Account State Change Event Payload", "properties":{ "financialAccount":{ "description":"The financial account with the changed state.", "$ref":"#/components/schemas/FinancialAccount" } }, "description":"The payload for FinancialAccountStateChangeEvent." }, "FinancialAccountDeleteEvent":{ "type":"object", "title":"Financial Account Delete Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "payload":{ "description":"The event's payload.", "$ref":"#/components/schemas/FinancialAccountDeleteEventPayload" } }, "description":"An event for deleting a financial account." }, "FinancialAccountDeleteEventPayload":{ "type":"object", "title":"Financial Account Delete Event Payload", "properties":{ "financialAccount":{ "description":"The financial account to delete.", "$ref":"#/components/schemas/FinancialAccount" } }, "description":"The payload for FinancialAccountDeleteEvent." }, "PartyAccountCreateEvent":{ "type":"object", "title":"Party Account Create Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The time the event occurred.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "payload":{ "description":"The event payload.", "$ref":"#/components/schemas/PartyAccountCreateEventPayload" } }, "description":"An event for creating a party account with given attributes." }, "PartyAccountCreateEventPayload":{ "type":"object", "title":"Party Account Create Event Payload", "properties":{ "partyAccount":{ "description":"The party account with valid attribute.", "$ref":"#/components/schemas/PartyAccount" } }, "description":"The payload for PartyAccountCreateEvent." }, "Error":{ "required":[ "code", "reason" ], "type":"object", "title":"Error", "properties":{ "code":{ "type":"string", "title":"Error Code", "description":"An application's error code, defined in the API or a common list." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the error." }, "message":{ "type":"string", "title":"Error Message", "description":"More details and corrective actions related to the error." }, "status":{ "type":"string", "title":"Error Status", "description":"The HTTP Error code extension" }, "referenceError":{ "type":"string", "title":"Reference Error", "description":"A URI to documentation describing the error.", "format":"uri" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"Used when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error)." }, "PaymentMethodType":{ "required":[ "@type", "details", "href", "id" ], "properties":{ "id":{ "type":"string", "description":"The payment method's ID." }, "href":{ "type":"string", "description":"The payment method's href." }, "name":{ "type":"string", "description":"The payment method's name." }, "description":{ "type":"string", "description":"The payment method's description." }, "validFor":{ "description":"The period of time for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriodType" }, "account":{ "type":"array", "description":"An account that owns or can use the payment method.", "items":{ "$ref":"#/components/schemas/AccountRefType" } }, "preferred":{ "type":"boolean", "description":"Whether this is the preferred payment method for the account, bill unit, or billing cycle specification (true) or not (false)." }, "relatedParty":{ "type":"array", "description":"The related party that owns the payment method.", "items":{ "$ref":"#/components/schemas/RelatedPartyRefType" } }, "@type":{ "type":"string", "description":"The payment method's type. The value of this property determines the content of the details property.", "enum":[ "tokenizedCard", "bankAccountDebit", "bankCard", "invoice" ] }, "authorizationCode":{ "type":"string", "description":"An authorization code provided by a financial institution. Typically for recurring payments using the payment method." }, "status":{ "type":"string", "description":"The payment method's status." }, "statusDate":{ "type":"string", "description":"The date the payment method's status was recorded.", "format":"date-time" }, "details":{ "type":"object", "description":"The payment method's details, which differ based on the '@type' property." } }, "description":"A payment method." }, "QuantityType":{ "required":[ "amount", "units" ], "properties":{ "amount":{ "type":"number", "description":"A numeric value.", "format":"decimal" }, "units":{ "type":"string", "description":"The unit the quantity is measured in." } }, "description":"A quantity or quantity range." }, "TimePeriodType":{ "required":[ "startDateTime" ], "properties":{ "startDateTime":{ "type":"string", "description":"The start of the time period.", "format":"date-time" }, "endDateTime":{ "type":"string", "description":"The end of the time period.", "format":"date-time" } }, "description":"A period of time." }, "RelatedPartyRefType":{ "required":[ "href", "id" ], "properties":{ "id":{ "type":"string", "description":"The related party's ID." }, "href":{ "type":"string", "description":"The related party's href." }, "@referredType":{ "type":"string", "description":"The type of related party. For example, account, customer, or user." }, "name":{ "type":"string", "description":"The related party's name." }, "role":{ "type":"string", "description":"The related party's role." } }, "description":"A related party." }, "PaymentMethodRequestType":{ "required":[ "details", "type" ], "properties":{ "name":{ "type":"string", "description":"The payment method's name." }, "description":{ "type":"string", "description":"The payment method's description." }, "validFor":{ "description":"The period of time for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriodType" }, "preferred":{ "type":"boolean", "description":"Whether this is the preferred payment method for the account (true) or not (false). If set to true, the payment method is assigned to the account's default bill unit." }, "account":{ "type":"array", "description":"An account that owns or can use the payment method.", "items":{ "$ref":"#/components/schemas/AccountRefType" } }, "relatedParty":{ "type":"array", "description":"The related party that owns the payment method.", "items":{ "$ref":"#/components/schemas/RelatedPartyRefType" } }, "type":{ "type":"string", "description":"The payment method's type. The value of this property determines the content of the details property.", "enum":[ "bankAccountDebit" ] }, "authorizationCode":{ "type":"string", "description":"An authorization code provided by a financial institution. Typically for recurring payments using the payment method." }, "status":{ "type":"string", "description":"The payment method's status." }, "details":{ "type":"object", "description":"The payment method's details, which differ based on the type property. Use the following properties: \n

\n" } }, "description":"A payment method, used in create requests. The id, href, and statusDate payment method properties that appear in get requests are not used in create requests. They are system generated." }, "BankCardType":{ "required":[ "brand", "cardNumber", "expirationDate" ], "properties":{ "brand":{ "type":"string", "description":"The card's brand. For example, Visa or MasterCard." }, "type":{ "type":"string", "description":"The card's type.", "enum":[ "Debit", "Credit" ] }, "cardNumber":{ "type":"string", "description":"The card's number." }, "expirationDate":{ "type":"string", "description":"The card's expiration date.", "format":"date-time" }, "cvv":{ "type":"string", "description":"The card's security code." }, "lastFourDigits":{ "type":"string", "description":"The card's last four digits." }, "nameOnCard":{ "type":"string", "description":"The name on the card." }, "bank":{ "type":"string", "description":"The name of the bank that issued the card." } }, "description":"A bank card." }, "TokenizedCardType":{ "required":[ "token", "tokenType" ], "properties":{ "brand":{ "type":"string", "description":"The card's brand. For example, Visa or MasterCard." }, "type":{ "type":"string", "description":"The card's type.", "enum":[ "Debit", "Credit" ] }, "lastFourDigits":{ "type":"string", "description":"The card's last four digits." }, "tokenType":{ "type":"string", "description":"The card's token type. Can be one of the following:\n\n" }, "token":{ "type":"string", "description":"The card's token." }, "issuer":{ "type":"string", "description":"The token's issuer." } }, "description":"A tokenized bank card." }, "BankAccountDebitType":{ "required":[ "accountNumber", "accountNumberType" ], "properties":{ "accountNumber":{ "type":"string", "description":"The bank account's IBAN or SWIFT number." }, "accountNumberType":{ "type":"string", "description":"The bank account's type. Can be one of the following:\n\n" }, "BIC":{ "type":"string", "description":"The Business Identifier Code for the account's bank." }, "owner":{ "type":"string", "description":"The bank account's owner." }, "bank":{ "type":"string", "description":"The name of the account's bank." } }, "description":"A bank account." }, "AccountRefType":{ "required":[ "href", "id" ], "properties":{ "id":{ "type":"string", "description":"The referred account's ID." }, "href":{ "type":"string", "description":"The referred account's href." }, "name":{ "type":"string", "description":"The referred account's name." }, "description":{ "type":"string", "description":"The referred account's description." }, "@referredType":{ "type":"string", "description":"The referred account's type. For example, customer account or financial account." } }, "description":"An account reference." }, "InvoiceType":{ "required":[ "mediumType" ], "properties":{ "mediumType":{ "type":"string", "description":"The type of invoice medium such as postalAddress or emailAddress.", "enum":[ "emailAddress", "postalAddress" ] }, "emailAddress":{ "type":"string", "description":"Full email address where invoice has to sent" }, "name":{ "type":"string", "description":"The name for postal address." }, "street":{ "type":"string", "description":"Describes the street." }, "city":{ "type":"string", "description":"Describes the city." }, "stateOrProvince":{ "type":"string", "description":"Describes the state." }, "postCode":{ "type":"string", "description":"Describes the post code." }, "country":{ "type":"string", "description":"Describes the country." } }, "description":"An invoice payment method." }, "Any":{ "type":"object" }, "BillingAccountRef":{ "type":"object", "title":"Billing Account Ref", "description":"A billing account is a detailed description of a bill structure.", "properties":{ "id":{ "type":"string", "description":"The unique ID for the billing account." }, "accountNumber":{ "type":"string", "description":"The account number." }, "href":{ "type":"string", "description":"A reference for the billing account." }, "name":{ "type":"string", "description":"The name of the billing account." }, "@baseType":{ "type":"string", "description":"The super-class when sub-classing." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The sub-class entity name when sub-classing." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } } }, "Characteristic":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"The name of the characteristic." }, "valueType":{ "type":"string", "description":"The data type for the characteristic's value." }, "value":{ "$ref":"#/components/schemas/Any" }, "@type":{ "type":"string", "description":"The sub-class entity name when sub-classing, such as CharacteristicOracle." }, "unitOfMeasure":{ "type":"string", "description":"The unit of measure of the characteristic." } }, "description":"Describes a given characteristic of an object or entity through a name-value pair.\nSkipped properties: baseType, schemaLocation, referredType" }, "fulfillBilling_Create":{ "required":[ "billingAccount" ], "type":"object", "properties":{ "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "package":{ "$ref":"#/components/schemas/PackageRef" }, "productOrderItem":{ "minItems":1, "type":"array", "items":{ "$ref":"#/components/schemas/ProductOrderItem" } }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } }, "description":"Initiates the performance of billing fulfillment." }, "OrderItemActionType":{ "type":"string", "description":"The action to be performed on the product: add, terminate, suspend, or resume.", "enum":[ "add", "terminate", "suspend", "resume" ] }, "OwnerAccount":{ "type":"object", "properties":{ "id":{ "type":"string", "title":"Owner Account ID", "description":"Unique identifier of the owner." }, "href":{ "type":"string", "title":"Owner Account Href", "description":"The href of the owner account reference." }, "name":{ "type":"string", "title":"Owner Account Name", "description":"The name of the owner account reference." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The superclass of the object." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The subclass of the object." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The type of the object, in the target system, if baseType and type need further disambiguation." } }, "description":"Provides unique identifier of the owner account." }, "PackageRef":{ "type":"object", "description":"Represents parent product order name.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of a related entity." }, "name":{ "type":"string", "description":"Name of the related entity." } } }, "PriceAlteration":{ "type":"object", "description":"The object is an amount, usually of money, that modifies the price charged for an order item.", "required":[ "price", "priceType" ], "properties":{ "description":{ "type":"string", "description":"A narrative that explains in detail the semantics of this order item price alteration." }, "name":{ "type":"string", "description":"Name of the order item price alteration." }, "priceType":{ "type":"string", "description":"A category that describes the price such as recurring, one time and usage." }, "priority":{ "type":"integer", "description":"It is a priority level for applying this alteration among all the defined alterations on the order item price." }, "recurringChargePeriod":{ "type":"string", "description":"Refers to a timeline, like month, week, etc." }, "unitOfMeasure":{ "type":"string", "description":"Refers to a unit of measurement like minutes, GB, etc." }, "price":{ "$ref":"#/components/schemas/Price" }, "@baseType":{ "type":"string", "description":"This defines the super-class when sub-classing." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } } }, "Product":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the product." }, "productCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/Characteristic" } }, "productTerm":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductTerm" } }, "ownerAccount":{ "$ref":"#/components/schemas/OwnerAccount" }, "serviceAccount":{ "$ref":"#/components/schemas/ServiceAccount" }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } }, "description":"A product offering procured by a customer or other interested party playing a party role. A product is realized as one or more service(s) and / or resource(s).\nSkipped properties: href, description, isBundle, isCustomerVisible, name, orderDate, productSerialNumber, startDate, terminationDate, agreement, billingAccount, place, product, productOrderItem, productPrice, productSpecification, realizingResource, realizingService, relatedParty, status, baseType, schemaLocation, type." }, "ProductOfferingRef":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of a related entity." }, "href":{ "type":"string", "description":"Reference of the related entity." }, "name":{ "type":"string", "description":"Name of the related entity." }, "type":{ "type":"string", "description":"Type of the related entity." }, "@baseType":{ "type":"string", "description":"This defines the super-class when sub-classing." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." }, "@referredType":{ "type":"string", "description":"The actual type of the target instance when needed for disambiguation." } }, "description":"A reference to the product offering. A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information." }, "ProductTerm":{ "type":"object", "description":"Description of a product term linked to this product. This represents a commitment with a duration.", "properties":{ "description":{ "type":"string", "description":"Description of the product term." }, "name":{ "type":"string", "description":"Name of the product term." }, "commitmentType":{ "type":"string", "description":"Commitment type of the product term." }, "duration":{ "$ref":"#/components/schemas/Quantity" }, "@baseType":{ "type":"string", "description":"This defines the super-class when sub-classing." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } } }, "Quantity":{ "type":"object", "description":"An amount in a given unit.", "properties":{ "amount":{ "default":1, "type":"number", "format":"float", "description":"Numeric value in a given unit." }, "units":{ "type":"string", "description":"Unit" } } }, "Price":{ "type":"object", "description":"Provides all amounts (tax included, duty free, tax rate), used currency and percentage to apply for Price Alteration.", "properties":{ "percentage":{ "type":"number", "format":"float" }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "dutyFreeAmount":{ "$ref":"#/components/schemas/Money" }, "taxAmount":{ "$ref":"#/components/schemas/Money" }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } } }, "PriceType":{ "type":"string", "description":"A category that describes the price, such as recurring, discount, allowance, penalty, and so forth.", "enum":[ "recurring", "oneTime", "usage", "/event/billing/product/fee/purchase", "/event/billing/product/fee/cycle/cycle_forward_monthly", "/event/billing/product/fee/cycle/cycle_forward_bimonthly", "/event/billing/product/fee/cycle/cycle_forward_quarterly", "/event/billing/product/fee/cycle/cycle_forward_semiannual", "/event/billing/product/fee/cycle/cycle_forward_annual", "/event/billing/product/fee/cycle/cycle_arrear", "downPayment" ] }, "ItemPrice":{ "type":"object", "description":"A list of order prices. It is an amount, usually of money, that represents the actual price paid by the customer for this item.", "properties":{ "description":{ "type":"string", "description":"A narrative that explains in detail the semantics of this order item price." }, "priceType":{ "$ref":"#/components/schemas/PriceType" }, "unitOfMeasure":{ "type":"string", "description":"It refers to a unit of measurement like minutes, gigaBytes, etc." }, "timePeriod":{ "$ref":"#/components/schemas/TimePeriod" }, "priceAlteration":{ "type":"array", "items":{ "$ref":"#/components/schemas/PriceAlteration" }, "description":"It refers to a strucuture used to describe a price alteration." }, "recurringChargePeriod":{ "type":"string", "description":"It refers to a time period like month, week, etc." }, "price":{ "$ref":"#/components/schemas/Price" }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } } }, "ItemTotalPrice":{ "type":"object", "properties":{ "description":{ "type":"string", "description":"A narrative that explains in detail the semantics of this order total item price, which includes its children." }, "priceType":{ "$ref":"#/components/schemas/PriceType" }, "price":{ "$ref":"#/components/schemas/Price" }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." } } }, "ProductOrderItem":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Identifier of the line item (generally it is a sequence number, like 01, 02, 03, etc)." }, "action":{ "$ref":"#/components/schemas/OrderItemActionType" }, "productOffering":{ "$ref":"#/components/schemas/ProductOfferingRef" }, "product":{ "$ref":"#/components/schemas/Product" }, "itemPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ItemPrice" } }, "itemTotalPrice":{ "type":"array", "items":{ "$ref":"#/components/schemas/ItemTotalPrice" } }, "billFulfillMode":{ "type":"string", "description":"Defines the billing mode if you support two-phased billing: initiate or fulfill." }, "requestedStartDate":{ "type":"string", "format":"date-time", "description":"The requested date and time to start the service." }, "requestedCompletionDate":{ "type":"string", "format":"date-time", "description":"The requested date and time to cancel the service in the future." }, "expectedCompletionDate":{ "type":"string", "format":"date-time", "description":"It refers to the expected delivery date amended by the provider." }, "@type":{ "type":"string", "description":"This defines the sub-class entity name when sub-classing." }, "productOrderItem":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductOrderItem" } } }, "description":"It refers to an identified part of the order. A product order is decomposed into one or more order items.\nSkipped properties: quantity, appointment, billingAccount, itemPrice, itemTerm, itemTotalPrice, payment, productOffering, productOfferingQualificationItem, productOrderItem, productOrderItemRelationship, qualification, quoteItem, state, @baseType, @schemaLocation, @type" }, "ServiceAccount":{ "type":"object", "properties":{ "id":{ "type":"string", "title":"Service Account ID", "description":"Unique identifier of the service." }, "href":{ "type":"string", "title":"Service Account Href", "description":"The href of the service account reference." }, "name":{ "type":"string", "title":"Service Account Name", "description":"The name of the service account reference." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The superclass of the object." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The subclass of the object." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The type of the object in the target system, if baseType and type need further disambiguation." } }, "description":"Provides unique identifier of the service account." }, "AccumulatedBalance":{ "required":[ "id", "bucket", "name", "totalBalance" ], "type":"object", "title":"Accumulated Balance", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The accumulated balance's ID." }, "href":{ "type":"string", "title":"Href", "description":"The accumulated balance's href." }, "description":{ "type":"string", "title":"description", "description":"The accumulated balance's description." }, "name":{ "type":"string", "title":"Name", "description":"The accumulated balance's name." }, "bucket":{ "minItems":1, "type":"array", "description":"The buckets containing the accumulated balance.", "items":{ "$ref":"#/components/schemas/BucketRef" } }, "logicalResource":{ "description":"The logical resource associated with the accumulated balance.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"The party account associated with the accumulated balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the accumulated balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the accumulated balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "totalBalance":{ "description":"The total amount of the accumulated balance.", "$ref":"#/components/schemas/Quantity" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An amount owed by an account, aggregating amounts contained in a set of buckets." }, "Action":{ "required":[ "status" ], "type":"object", "title":"Action", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The action's ID." }, "href":{ "type":"string", "title":"Href", "description":"The action's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the action was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The action's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the action." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the request for the action was made.", "format":"date-time" }, "amount":{ "description":"The amount associated with the action.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket associated with the action.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel associated with the action.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the action.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"A party account associated with the action.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the action.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the action.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party that requested the action.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The action's status.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The usage type associated with the action.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the action is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An abstract resource for an action, such as adjusting or deducting a balance." }, "ActionStatusType":{ "type":"string", "title":"Action Status Type", "description":"The status of an action.", "enum":[ "created", "failed", "cancelled", "completed" ] }, "Addressable":{ "type":"object", "title":"Addressable", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The addressable entity's ID." }, "href":{ "type":"string", "title":"Href", "description":"The addressable entity's href." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"The base schema for addressable entities." }, "AdjustBalance":{ "required":[ "status", "id", "reason", "amount", "requestedDate" ], "type":"object", "title":"Adjust Balance", "properties":{ "id":{ "type":"string", "title":"Adjust Balance ID", "description":"The adjusted balance's ID." }, "href":{ "type":"string", "title":"Adjust Balance Href", "description":"The adjusted balance's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the adjustment was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Adjust Balance Description", "description":"The adjusted balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the adjustment." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the request was received.", "format":"date-time" }, "adjustType":{ "description":"The adjustment type.", "$ref":"#/components/schemas/AdjustType" }, "amount":{ "description":"The amount to adjust.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket to track the adjustment in.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the adjustment.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the adjusted balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the adjusted balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party that requested the adjustment.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The adjustment's status.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The usage type associated with the adjusted balance.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the adjusted balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An adjustment to a balance." }, "AdjustBalance_Create":{ "required":[ "amount" ], "type":"object", "title":"Adjust Balance Create", "properties":{ "description":{ "type":"string", "title":"Description", "description":"The adjusted balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the adjustment." }, "adjustType":{ "description":"The type of adjustment.", "$ref":"#/components/schemas/AdjustType" }, "amount":{ "description":"The amount to adjust. The amount can be a positive or negative integer.

For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due.

For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket to track the adjustment in. For non-currency adjustments, this is required.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the adjustment.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "product":{ "type":"array", "description":"Products associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "requestor":{ "description":"The party that requested the adjustment.", "$ref":"#/components/schemas/RelatedParty" }, "usageType":{ "description":"The usage type for the adjustment.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the adjustment is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An adjustment to a balance, used in AdjustBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests.

The value for amount can be a positive or negative integer. For bill and item adjustments, a positive amount indicates a debit adjustment to increase the amount due and a negative amount indicates a credit adjustment to decrease the amount due. For event adjustments, the opposite is true: a positive amount indicates a credit adjustment to decrease the amount due and a negative amount indicates a debit adjustment to increase the amount due.

For non-currency adjustments, the bucket property is required." }, "AdjustBalance_Update":{ "required":[ "status" ], "type":"object", "title":"Adjust Balance Update", "properties":{ "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the adjustment was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Adjust Balance Description", "description":"The adjusted balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the adjustment." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the request was received.", "format":"date-time" }, "adjustType":{ "description":"The adjustment type.", "$ref":"#/components/schemas/AdjustType" }, "amount":{ "description":"The amount to adjust.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket to track the adjustment in.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the adjustment.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the adjusted balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the adjusted balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the adjusted balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party that requested the adjustment.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The adjustment's status.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The usage type associated with the adjusted balance.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the adjusted balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"An adjustment to a balance, used in AdjustBalance update requests. The id and href properties are not used in update requests." }, "AdjustType":{ "type":"string", "title":"Adjust Type", "description":"The type of adjustment.", "enum":[ "recurring", "oneTime" ] }, "BalanceActionHistory":{ "required":[ "receiverLogicalResource", "status" ], "type":"object", "title":"Balance Action History", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The historical action's ID." }, "href":{ "type":"string", "title":"Href", "description":"The historical action's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the action was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The action's description." }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"Whether the action is an automatic top-up (true) or not (false)." }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurred." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the action." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the request for the action was made.", "format":"date-time" }, "voucher":{ "type":"string", "title":"Voucher", "description":"A voucher used for a top-up." }, "adjustType":{ "description":"The type of adjustment.", "$ref":"#/components/schemas/AdjustType" }, "amount":{ "description":"The amount to be adjusted.", "$ref":"#/components/schemas/Quantity" }, "balanceTopup":{ "description":"A top-up associated with the action.", "$ref":"#/components/schemas/RelatedTopupBalance" }, "bucket":{ "description":"The bucket associated with the action.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel for the action.", "$ref":"#/components/schemas/ChannelRef" }, "costOwner":{ "description":"The type of cost owner for the action.", "$ref":"#/components/schemas/CostOwnerType" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the action.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the action.", "$ref":"#/components/schemas/PartyAccountRef" }, "paymentMethod":{ "description":"The payment method for the action.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "type":"array", "description":"Products associated with the action.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "receiver":{ "description":"The related party receiving the action.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the action.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "description":"The usage type for the bucket receiving the action.", "$ref":"#/components/schemas/UsageType" }, "receiverLogicalResource":{ "description":"The logical resource associated with the receiver of the action.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverProduct":{ "description":"The product receiving the action.", "$ref":"#/components/schemas/ProductRef" }, "recurringPeriod":{ "description":"The recurring period for the action.", "$ref":"#/components/schemas/RecurringPeriodType" }, "relatedParty":{ "type":"array", "description":"Parties related to the action.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party that requested the action.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The action's status.", "$ref":"#/components/schemas/ActionStatusType" }, "transferCost":{ "description":"The cost of a transfer action.", "$ref":"#/components/schemas/Money" }, "usageType":{ "description":"The usage type associated with the action.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the action is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A past action performed on a bucket. Possible actions include TopupBalance, AdjustBalance, and TransferBalance." }, "Bucket":{ "required":[ "id", "href", "validFor", "status" ], "type":"object", "title":"Bucket", "properties":{ "id":{ "type":"string", "title":"Bucket ID", "description":"The bucket's ID." }, "href":{ "type":"string", "title":"Bucket Href", "description":"The bucket's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that an action on the bucket was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The bucket's description." }, "isShared":{ "type":"boolean", "title":"Is Shared", "description":"Whether the bucket is shared between several devices or users (true) or not (false)." }, "name":{ "type":"string", "title":"Bucket Name", "description":"The bucket's name." }, "remainingValueName":{ "type":"string", "title":"Remaining Value", "description":"A string, including value and unit, representing the remaining amount in the bucket, used for display purposes. For example, 1.9 GB." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that a request about the bucket was made.", "format":"date-time" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the bucket.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the bucket.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the bucket.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the bucket.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "remainingValue":{ "description":"The amount remaining in the bucket.", "$ref":"#/components/schemas/Quantity" }, "reservedValue":{ "description":"The amount reserved in the bucket.", "$ref":"#/components/schemas/Quantity" }, "status":{ "description":"The bucket's status.", "$ref":"#/components/schemas/BucketStatusType" }, "usageType":{ "description":"The bucket's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the bucket is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A bucket that tracks a quantity of usage (remaining or consumed) for currency or non-currency resources (such as messages, minutes, data)." }, "BucketRef":{ "required":[ "id" ], "type":"object", "title":"Bucket Ref", "properties":{ "id":{ "type":"string", "title":"Bucket ID", "description":"The bucket's ID." }, "href":{ "type":"string", "title":"Bucket Href", "description":"The bucket's href." }, "name":{ "type":"string", "title":"Bucket Name", "description":"The bucket's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to a bucket." }, "BucketStatusType":{ "type":"string", "title":"Bucket Status Type", "description":"A bucket's status.", "enum":[ "active", "suspended", "expired" ] }, "ChannelRef":{ "required":[ "id" ], "type":"object", "title":"Channel Ref", "properties":{ "id":{ "type":"string", "title":"Channel ID", "description":"The channel's ID." }, "href":{ "type":"string", "title":"Channel Href", "description":"The channel's href." }, "name":{ "type":"string", "title":"Channel Name", "description":"The channel's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to a channel." }, "CostOwnerType":{ "type":"string", "title":"Cost OwnerType", "description":"The type of cost owner.", "enum":[ "originator", "receiver" ] }, "Extensible":{ "type":"object", "title":"Extensible", "properties":{ "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A base extensible schema." }, "LogicalResourceRef":{ "required":[ "id" ], "type":"object", "title":"Logical Resource Ref", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The resource's ID." }, "href":{ "type":"string", "title":"Href", "description":"The resource's href." }, "name":{ "type":"string", "title":"Name", "description":"The resource's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to a logical resource." }, "PartyAccountRef":{ "required":[ "id" ], "type":"object", "title":"Party Account Ref", "properties":{ "id":{ "type":"string", "title":"Account ID", "description":"The party account's ID." }, "href":{ "type":"string", "title":"Href", "description":"The party account's href." }, "description":{ "type":"string", "title":"Description", "description":"The party account's description." }, "name":{ "type":"string", "title":"Name", "description":"The party account's name." }, "status":{ "type":"string", "title":"Status", "description":"The overall status of the account. For example, due, paid, or in arrears." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to a party account." }, "ProductRef":{ "required":[ "id" ], "type":"object", "title":"Product Ref", "description":"A reference to a product.", "properties":{ "id":{ "type":"string", "title":"Product ID", "description":"The product's ID." }, "href":{ "type":"string", "title":"Product Href", "description":"The product's href." }, "name":{ "type":"string", "title":"Product Name", "description":"The product's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } } }, "RecurringPeriodType":{ "type":"string", "title":"Recurring Period Type", "description":"A type of recurring period.", "enum":[ "weekly", "fortnightly", "monthly" ] }, "RelatedTopupBalance":{ "required":[ "@referredType", "id" ], "type":"object", "title":"Related Topup Balance", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The balance's ID." }, "href":{ "type":"string", "title":"Href", "description":"The balance's href." }, "name":{ "type":"string", "title":"Name", "description":"The balance's name." }, "role":{ "type":"string", "title":"Role", "description":"The balance's role. For example, parent or child." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A relationship between balance top-ups, that defines whether a balance is the parent or child of another." }, "ReserveBalance":{ "required":[ "status" ], "type":"object", "title":"Reserve Balance", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The reserved balance's ID." }, "href":{ "type":"string", "title":"Href", "description":"The reserved balance's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the reservation was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The reserved balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason the balance was reserved." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the reservation request was made.", "format":"date-time" }, "amount":{ "description":"The amount reserved.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the reserved balance.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The reserved balance's channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the reserved balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the reserved balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party requesting the reservation.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The request's status.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The reserved balance's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the reserved balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A reserved balance." }, "ReserveBalance_Create":{ "required":[ "bucket", "partyAccount", "usageType" ], "type":"object", "title":"Reserve Balance Create", "properties":{ "description":{ "type":"string", "title":"Description", "description":"The reserved balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason the balance was reserved." }, "amount":{ "description":"The amount reserved.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the reserved balance.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The reserved balance's channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the reserved balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "requestor":{ "description":"The party requesting the reservation.", "$ref":"#/components/schemas/RelatedParty" }, "usageType":{ "description":"The reserved balance's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the reserved balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A reserved balance, used in ReserveBalance create requests. The id, href, status, requestedDate, confirmationDate, and relatedParty properties are not used in the create request." }, "ReserveBalance_Update":{ "required":[ "reason", "status" ], "type":"object", "title":"Reserve Balance Update", "properties":{ "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that the reservation was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The reserved balance's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason the balance was reserved." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the reservation request was made.", "format":"date-time" }, "amount":{ "description":"The amount reserved.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the reserved balance.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The reserved balance's channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the reserved balance.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the reserved balance.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Parties related to the reserved balance.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party requesting the reservation.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The request's status.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The reserved balance's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the reserved balance is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A reserved balance, used in ReserveBalance update requests. The id and href properties are not used in update requests." }, "TopupBalance":{ "required":[ "status" ], "type":"object", "title":"Topup Balance", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The top-up balance's ID." }, "href":{ "type":"string", "title":"Href", "description":"The top-up balance's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the top-up was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"Whether the top-up is automatic (true) or not (false)." }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, then the top-up will continue automatically indefinitely." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the top-up request was made.", "format":"date-time" }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "balanceTopup":{ "description":"The top-up's balance.", "$ref":"#/components/schemas/RelatedTopupBalance" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the top-up.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "type":"array", "description":"Products associated with the top-up.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "recurringPeriod":{ "description":"The type of recurring period for the top-up.", "$ref":"#/components/schemas/RecurringPeriodType" }, "relatedParty":{ "type":"array", "description":"Parties related to the top-up.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The status of the request.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The top-up's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the top-up is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A top-up." }, "TopupBalance_Create":{ "required":[ "amount", "bucket", "partyAccount", "usageType" ], "type":"object", "title":"Topup Balance Create", "properties":{ "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"Whether the top-up is automatic (true) or not (false)." }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, then the top-up will continue automatically indefinitely." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "balanceTopup":{ "description":"The top-up's balance.", "$ref":"#/components/schemas/RelatedTopupBalance" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the top-up.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "type":"array", "description":"Products associated with the top-up.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "recurringPeriod":{ "description":"The type of recurring period for the top-up.", "$ref":"#/components/schemas/RecurringPeriodType" }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "usageType":{ "description":"The top-up's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the top-up is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A top-up, used in TopupBalance create requests. The id, href, status, requestedDate, confirmationDate, and relatedParty properties are not used in create requests." }, "TopupBalance_Update":{ "required":[ "status" ], "type":"object", "title":"Topup Balance Update", "properties":{ "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date that top-up was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The top-up's description." }, "isAutoTopup":{ "type":"boolean", "title":"Is Auto Topup", "description":"Whether the top-up is automatic (true) or not (false)." }, "numberOfPeriods":{ "type":"integer", "title":"Number of Periods", "description":"The number of billing periods for which an automatic top-up occurs. If this property is not specified, then the top-up will continue automatically indefinitely." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the top-up." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the top-up request was made.", "format":"date-time" }, "voucher":{ "type":"string", "title":"Voucher", "description":"The voucher used for the top-up." }, "amount":{ "description":"The amount to be topped up.", "$ref":"#/components/schemas/Quantity" }, "balanceTopup":{ "description":"The top-up's balance.", "$ref":"#/components/schemas/RelatedTopupBalance" }, "bucket":{ "description":"The bucket tracking the top-up.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The top-up channel.", "$ref":"#/components/schemas/ChannelRef" }, "logicalResource":{ "type":"array", "description":"Logical resources associated with the top-up.", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the top-up.", "$ref":"#/components/schemas/PartyAccountRef" }, "paymentMethod":{ "description":"The payment method for the top-up.", "$ref":"#/components/schemas/PaymentMethodRef" }, "product":{ "type":"array", "description":"Products associated with the top-up.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "recurringPeriod":{ "description":"The type of recurring period for the top-up.", "$ref":"#/components/schemas/RecurringPeriodType" }, "relatedParty":{ "type":"array", "description":"Parties related to the top-up.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party requesting the top-up.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The status of the request.", "$ref":"#/components/schemas/ActionStatusType" }, "usageType":{ "description":"The top-up's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the top-up is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A top-up, used in TopupBalance update requests. The id and href properties are not used in update requests." }, "TransferBalance":{ "required":[ "channel", "href", "id", "logicalResource", "reason", "receiverLogicalResource", "status" ], "type":"object", "title":"Transfer Balance", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The transferred balance's ID." }, "href":{ "type":"string", "title":"Href", "description":"The transferred balance's href." }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the transfer was confirmed.", "format":"date-time" }, "description":{ "type":"string", "title":"Description", "description":"The transfer's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date that the request was received.", "format":"date-time" }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "costOwner":{ "description":"Whether the cost owner is sending or receiving the transfer.", "$ref":"#/components/schemas/CostOwnerType" }, "logicalResource":{ "minItems":1, "description":"Logical resources associated with the transfer.", "type":"array", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "partyAccount":{ "description":"The party account associated with the transfer.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "description":"Products associated with the transfer.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "description":"The usage type of the bucket receiving the transfer.", "$ref":"#/components/schemas/UsageType" }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "relatedParty":{ "type":"array", "description":"A party related to the transfer.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "description":"The request's status.", "$ref":"#/components/schemas/ActionStatusType" }, "transferCost":{ "description":"The cost of the transfer.", "$ref":"#/components/schemas/Money" }, "usageType":{ "description":"The transfer's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the transfer is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A balance being transferred between buckets." }, "TransferBalance_Create":{ "required":[ "amount", "bucket", "channel", "logicalResource", "reason", "receiverBucket", "receiverBucketUsageType", "receiverLogicalResource", "usageType" ], "type":"object", "title":"Transfer Balance Create", "properties":{ "description":{ "type":"string", "title":"Description", "description":"The transfer's description." }, "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "costOwner":{ "description":"Whether the cost owner is sending or receiving the transfer.", "$ref":"#/components/schemas/CostOwnerType" }, "logicalResource":{ "minItems":1, "description":"Logical resources associated with the transfer.", "type":"array", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "product":{ "type":"array", "description":"Products associated with the transfer.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "description":"The usage type of the bucket receiving the transfer.", "$ref":"#/components/schemas/UsageType" }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "transferCost":{ "description":"The cost of the transfer.", "$ref":"#/components/schemas/Money" }, "usageType":{ "description":"The transfer's usage type.", "$ref":"#/components/schemas/UsageType" }, "validFor":{ "description":"The time period for which the transfer is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A balance being transferred between buckets, used in TransferBalance create requests. The id, href, status, requestedDate, confirmationDate, relatedParty, and partyAccount properties are not used in create requests." }, "TransferBalance_Update":{ "required":[ "channel", "logicalResource", "reason", "receiverLogicalResource" ], "type":"object", "title":"Transfer Balance Update", "properties":{ "reason":{ "type":"string", "title":"Reason", "description":"The reason for the transfer." }, "amount":{ "description":"The amount to be transferred.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket tracking the transfer.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The transfer channel.", "$ref":"#/components/schemas/ChannelRef" }, "costOwner":{ "description":"Whether the cost owner is sending or receiving the transfer.", "$ref":"#/components/schemas/CostOwnerType" }, "logicalResource":{ "minItems":1, "description":"Logical resources associated with the transfer.", "type":"array", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "product":{ "type":"array", "description":"Products associated with the transfer.", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "receiver":{ "description":"The party receiving the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "receiverBucket":{ "description":"The bucket receiving the transfer.", "$ref":"#/components/schemas/BucketRef" }, "receiverBucketUsageType":{ "description":"The usage type of the bucket receiving the transfer.", "$ref":"#/components/schemas/UsageType" }, "receiverLogicalResource":{ "description":"A logical resource associated with the entity receiving the transfer.", "$ref":"#/components/schemas/LogicalResourceRef" }, "receiverProduct":{ "description":"A product associated with the entity receiving the transfer.", "$ref":"#/components/schemas/ProductRef" }, "requestor":{ "description":"The party requesting the transfer.", "$ref":"#/components/schemas/RelatedParty" }, "transferCost":{ "description":"The cost of the transfer.", "$ref":"#/components/schemas/Money" }, "usageType":{ "description":"The transfer's usage type.", "$ref":"#/components/schemas/UsageType" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A balance being transferred between buckets, used in TransferBalance update requests. The id, href, status, requestedDate, confirmationDate, relatedParty, partyAccount, validFor, and description properties are not used in update requests." }, "UsageType":{ "type":"string", "title":"Usage Type", "description":"The type of usage. For BRM REST Services Manager, only monetary and other are supported.", "enum":[ "monetary", "voice", "data", "sms", "other" ] }, "TopupBalanceCreateEvent":{ "type":"object", "title":"Topup Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceCreateEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a top-up balance." }, "TopupBalanceCreateEventPayload":{ "type":"object", "title":"Topup Balance Create Event Payload", "properties":{ "topupBalance":{ "description":"The top-up balance to create.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceCreateEvent." }, "TopupBalanceCancelEvent":{ "type":"object", "title":"Topup Balance Cancel Event", "description":"An event to cancel a balance top-up.", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceCancelEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } } }, "TopupBalanceCancelEventPayload":{ "type":"object", "title":"Topup Balace Cancel Event Payload", "properties":{ "topupBalance":{ "description":"The top-up balance to cancel.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceCancelEvent." }, "TopupBalanceFailureEvent":{ "type":"object", "title":"Topup Balance Failure Event", "description":"An event for a failed balance top-up.", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TopupBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } } }, "TopupBalanceFailureEventPayload":{ "type":"object", "title":"Topup Balance Failure Event Payload", "properties":{ "topupBalance":{ "description":"The failed balance top-up.", "$ref":"#/components/schemas/TopupBalance" } }, "description":"The payload for TopupBalanceFailureEvent." }, "AdjustBalanceCreateEvent":{ "type":"object", "title":"Adjust Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/AdjustBalanceCreateEventPayload" }, "eventId":{ "type":"string", "description":"The event's ID." }, "eventTime":{ "type":"string", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "description":"The event's type." }, "correlationId":{ "type":"string", "description":"The event's correlation ID." }, "domain":{ "type":"string", "description":"The event's domain." }, "title":{ "type":"string", "description":"The event's title." }, "description":{ "type":"string", "description":"The event's description." }, "priority":{ "type":"string", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a balance adjustment." }, "AdjustBalanceCreateEventPayload":{ "type":"object", "title":"Adjust Balance Create Event Payload", "properties":{ "adjustBalance":{ "description":"The adjusted balance to create.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceCreateEvent." }, "AdjustBalanceCancelEvent":{ "type":"object", "title":"Adjust Balance Cancel Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/AdjustBalanceCancelEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for canceling a balance adjustment." }, "AdjustBalanceCancelEventPayload":{ "type":"object", "title":"Adjust Balance Cancel Event Payload", "properties":{ "adjustBalance":{ "description":"The balance adjustment to cancel.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceCancelEvent." }, "AdjustBalanceFailureEvent":{ "type":"object", "title":"Adjust Balance Failure Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/AdjustBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for a failed balance adjustment." }, "AdjustBalanceFailureEventPayload":{ "type":"object", "title":"Adjust Balance Failure Event Payload", "properties":{ "adjustBalance":{ "description":"The failed balance adjustment.", "$ref":"#/components/schemas/AdjustBalance" } }, "description":"The payload for AdjustBalanceFailureEvent." }, "TransferBalanceCreateEvent":{ "type":"object", "title":"Transfer Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TransferBalanceCreateEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a balance transfer." }, "TransferBalanceCreateEventPayload":{ "type":"object", "title":"Transfer Balance Create Event Payload", "properties":{ "transferBalance":{ "description":"The balance transfer to create.", "$ref":"#/components/schemas/TransferBalance" } }, "description":"The payload for TransferBalanceCreateEvent." }, "TransferBalanceCancelEvent":{ "type":"object", "title":"Transfer Balance Cancel Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TransferBalanceCancelEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for canceling a balance transfer." }, "TransferBalanceCancelEventPayload":{ "type":"object", "title":"Transfer Balance Cancel Event Payload", "properties":{ "transferBalance":{ "description":"The balance transfer to cancel.", "$ref":"#/components/schemas/TransferBalance" } }, "description":"The payload for TransferBalanceCancelEvent." }, "TransferBalanceFailureEvent":{ "type":"object", "title":"Transfer Balance Failure Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/TransferBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for a failed balance transfer." }, "TransferBalanceFailureEventPayload":{ "type":"object", "title":"Transfer Balance Failure Event Payload", "properties":{ "transferBalance":{ "description":"The failed balance transfer.", "$ref":"#/components/schemas/TransferBalance" } }, "description":"The payload for TransferBalanceFailureEvent." }, "ReserveBalanceCreateEvent":{ "type":"object", "title":"Reserved Balance Create Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/ReserveBalanceCreateEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for creating a balance reservation." }, "ReserveBalanceCreateEventPayload":{ "type":"object", "title":"Reserved Balance Create Event Payload", "properties":{ "reserveBalance":{ "description":"The balance reservation to create.", "$ref":"#/components/schemas/ReserveBalance" } }, "description":"The payload for ReserveBalanceCreateEvent." }, "ReserveBalanceCancelEvent":{ "type":"object", "title":"Reserved Balance Cancel Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/ReserveBalanceCancelEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for canceling a balance reservation." }, "ReserveBalanceCancelEventPayload":{ "type":"object", "title":"Reserve Balance Cancel Event Payload", "properties":{ "reserveBalance":{ "description":"The balance reservation to cancel.", "$ref":"#/components/schemas/ReserveBalance" } }, "description":"The payload for ReserveBalanceCancelEvent." }, "ReserveBalanceFailureEvent":{ "type":"object", "title":"Reserve Balance Failure Event", "properties":{ "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/ReserveBalanceFailureEventPayload" }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Event Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" } }, "description":"An event for a failed balance reservation." }, "ReserveBalanceFailureEventPayload":{ "type":"object", "title":"Reserve Balance Failure Event Payload", "properties":{ "reserveBalance":{ "description":"The failed balance reservation.", "$ref":"#/components/schemas/ReserveBalance" } }, "description":"The payload for ReserveBalanceFailureEvent." }, "BillingCycleSpecificationRefOracle":{ "title":"Billing Cycle Specification Ref Oracle", "description":"A reference to a billing cycle specification, extended for BRM REST Services Manager.", "type":"object", "properties":{ "id":{ "title":"ID", "type":"string", "description":"The billing cycle specification's ID." }, "href":{ "type":"string", "title":"Href", "description":"The billing cycle specification's href." }, "name":{ "type":"string", "title":"Name", "description":"The billing cycle specification's name." } } }, "BieFieldOracle":{ "required":[ "id" ], "type":"object", "title":"BIEField Oracle", "description":"A bill, item, or event, extended for BRM REST Services Manager", "properties":{ "id":{ "type":"string", "title":"ID", "description":"The bill, item, or event ID." }, "href":{ "type":"string", "title":"Href", "description":"The bill, item, or event href." } } }, "DisputeBalanceOracle":{ "required":[ "id", "href", "bill", "billingCycleSpecification" ], "title":"Dispute Balance Oracle", "description":"A disputed balance, extended for BRM REST Services Manager.", "type":"object", "properties":{ "id":{ "title":"Dispute ID", "type":"string", "description":"The disputed balance's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed balance's href." }, "actionType":{ "type":"string", "title":"Action Type", "description":"The type of balance being disputed.", "enum":[ "BillDispute", "ItemDispute", "EventDispute" ] }, "disputeNo":{ "title":"Dispute Number", "type":"string", "description":"The dispute number to displayed on a bill." }, "amount":{ "description":"The disputed amount.", "$ref":"#/components/schemas/Quantity" }, "taxAmount":{ "description":"The tax amount for the dispute.", "$ref":"#/components/schemas/Quantity" }, "reason":{ "title":"Dispute Reason", "type":"string", "description":"The reason for the dispute." }, "description":{ "title":"Dispute Description", "type":"string", "description":"The dispute's description." }, "partyAccount":{ "description":"The party account associated with the dispute.", "$ref":"#/components/schemas/PartyAccountRef" }, "discount":{ "title":"Discount", "type":"string", "description":"A discount associated with the dispute." }, "taxTreatment":{ "title":"Tax Treatment", "description":"The status of taxes on the dispute.", "type":"string", "enum":[ "TaxIncluded", "TaxExcluded", "TaxOnly" ] }, "confirmationDate":{ "type":"string", "title":"Confirmation Date", "description":"The date the dispute was confirmed.", "format":"date-time" }, "requestedDate":{ "type":"string", "title":"Requested Date", "description":"The date the request was made.", "format":"date-time" }, "billingCycleSpecification":{ "description":"The billing cycle specification associated with the dispute.", "$ref":"#/components/schemas/BillingCycleSpecificationRefOracle" }, "bill":{ "description":"The bill associated with the dispute.", "$ref":"#/components/schemas/BillRef" }, "billItem":{ "type":"array", "description":"The bill items associated with the dispute.", "items":{ "$ref":"#/components/schemas/BillItemDisputeOracle" } }, "billEvent":{ "type":"array", "description":"Events associated with the dispute.", "items":{ "$ref":"#/components/schemas/BillEventDisputeOracle" } }, "status":{ "title":"Status", "type":"string", "description":"The dispute's status.", "enum":[ "Settled", "Open" ] }, "settlementId":{ "title":"Settlement ID", "type":"string", "description":"The ID of the settlement associated with the dispute." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "DisputeBalance_CreateOracle":{ "required":[ "bieId", "amount" ], "title":"Dispute Balance Create Oracle", "description":"A disputed balance, used in DisputeBalance create requests.", "type":"object", "properties":{ "actionType":{ "title":"Action Type", "type":"string", "description":"The type of balance being disputed.", "enum":[ "BillDispute", "EventDispute", "ItemDispute" ] }, "amount":{ "description":"The amount of the disputed balance.", "$ref":"#/components/schemas/Quantity" }, "bieId":{ "type":"array", "x-cardinality":"1", "description":"The bill, item, or event IDs associated with the dispute.", "items":{ "$ref":"#/components/schemas/BieFieldOracle" } }, "taxTreatment":{ "title":"Tax Treatment", "description":"The status of taxes on the dispute.", "type":"string", "enum":[ "TaxIncluded", "TaxExcluded", "TaxOnly" ] }, "reason":{ "title":"Dispute Reason", "type":"string", "description":"The reason for the dispute." }, "description":{ "title":"Dispute Description", "type":"string", "description":"The dispute's description." }, "partyAccount":{ "description":"The party account associated with the dispute.", "$ref":"#/components/schemas/PartyAccountRef" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "BillEventDisputeOracle":{ "title":"BillEvent Dispute Oracle", "description":"A disputed bill event.", "type":"object", "properties":{ "id":{ "title":"Id", "type":"string", "description":"The disputed event's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed event's href." }, "name":{ "title":"Name", "type":"string", "description":"The disputed event's name." }, "originalCharge":{ "description":"The original amount charged that is being disputed.", "$ref":"#/components/schemas/Money" }, "adjustmentAmount":{ "description":"The adjusted amount to settle the dispute.", "$ref":"#/components/schemas/Money" } } }, "BillItemDisputeOracle":{ "required":[ "id", "href", "name" ], "title":"BillItem Dispute Oracle", "description":"A disputed bill item (AppliedCustomerBillingRate).", "type":"object", "properties":{ "id":{ "title":"Id", "type":"string", "description":"The disputed item's ID." }, "href":{ "title":"Href", "type":"string", "description":"The disputed item's href." }, "name":{ "title":"Name", "type":"string", "description":"The disputed item's name." }, "originalCharge":{ "description":"The original amount charged that is being disputed.", "$ref":"#/components/schemas/Money" }, "adjustmentAmount":{ "description":"The adjusted amount to settle the dispute.", "$ref":"#/components/schemas/Money" } } }, "BillRef":{ "type":"object", "title":"Bill Ref", "description":"A reference to a bill.", "properties":{ "id":{ "type":"string", "title":"Bill ID", "description":"The bill's ID." }, "href":{ "type":"string", "title":"Bill Href", "description":"The bill's href." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The actual type of the target instance when needed for disambiguation." } }, "required":[ "id", "href" ] }, "Bucket_Create":{ "required":[ "usageType" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "description":{ "type":"string", "description":"Text describing the contents of the balance managed by the bucket" }, "isShared":{ "type":"boolean", "description":"True if the bucket is shared between several devices or users" }, "logicalResource":{ "type":"array", "items":{ "$ref":"#/components/schemas/LogicalResourceRef" } }, "name":{ "type":"string", "description":"Friendly name to identify the bucket" }, "partyAccount":{ "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProductRef" } }, "relatedParty":{ "type":"array", "description":"Used to provide information about any other entity with relation to the balance, for instance to define customer hierarchy for the balance (e.g.: customerId, userId, )", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "remainingValue":{ "$ref":"#/components/schemas/Quantity" }, "remainingValueName":{ "type":"string", "description":"Remaining amount in a formatted string for the bucket given in the balance unit (for example 1.9 Gb). This formatted string could be used for display needs for example" }, "reservedValue":{ "$ref":"#/components/schemas/Quantity" }, "status":{ "type":"string", "description":"status for the bucket. active, expired, suspended" }, "usageType":{ "type":"string", "description":"The bucket's usage type." }, "validFor":{ "description":"The time period for which the bucket is valid.", "$ref":"#/components/schemas/TimePeriod" } }, "description":"A bucket, used in bucket create requests." }, "AdjustThreshold":{ "required":[ "accountId" ], "title":"Adjust Threshold", "type":"object", "properties":{ "accountId":{ "type":"string", "title":"Account Id", "description":"The ID or account number of the billing account to adjust the threshold for." }, "bucket":{ "description":"The bucket to adjust the threshold for.", "$ref":"#/components/schemas/BucketRef" }, "product":{ "description":"A product associated with the bucket being adjusted.", "$ref":"#/components/schemas/ProductRef" }, "resourceType":{ "type":"string", "title":"Resource Type", "description":"The resource type of the balance element with the adjusted threshold." }, "thresholds":{ "type":"array", "description":"The new threshold amount.", "items":{ "$ref":"#/components/schemas/Quantity" } }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A threshold adjustment." }, "BalanceAction":{ "required":[ "@type" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amount":{ "description":"The amount associated with the action.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"The bucket associated with the action.", "$ref":"#/components/schemas/BucketRef" }, "channel":{ "description":"The channel associated with the action.", "$ref":"#/components/schemas/ChannelRef" }, "confirmationDate":{ "type":"string", "description":"The date that the action was confirmed.", "format":"date-time" }, "description":{ "type":"string", "description":"The action's description." }, "href":{ "type":"string", "description":"The action's href." }, "id":{ "type":"string", "description":"The action's ID." }, "impactedBucket":{ "type":"array", "description":"Buckets impacted by the request.", "items":{ "$ref":"#/components/schemas/ImpactedBucket" } }, "logicalResource":{ "description":"A logical resource associated with the action.", "$ref":"#/components/schemas/LogicalResourceRef" }, "partyAccount":{ "description":"A party account associated with the action.", "$ref":"#/components/schemas/PartyAccountRef" }, "product":{ "description":"A product associated with the action.", "$ref":"#/components/schemas/ProductRef" }, "reason":{ "type":"string", "description":"The reason for the action." }, "relatedParty":{ "type":"array", "description":"Parties related to the action. to the operation", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "requestedDate":{ "type":"string", "description":"The date that the request for the action was made.", "format":"date-time" }, "requestor":{ "description":"The party that requested the action.", "$ref":"#/components/schemas/RelatedParty" }, "status":{ "type":"string", "description":"The request's status." }, "usageType":{ "type":"string", "description":"The action's usage type." } }, "description":"An abstract resource for an action, such as adjusting or topping up a balance. " }, "ImpactedBucket":{ "required":[ "item" ], "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amountAfter":{ "description":"The amount in the bucket after the impact.", "$ref":"#/components/schemas/Quantity" }, "amountBefore":{ "description":"The amount in the bucket before the impact.", "$ref":"#/components/schemas/Quantity" }, "bucket":{ "description":"A reference to the impacted bucket.", "$ref":"#/components/schemas/BucketRef" }, "confirmationDate":{ "type":"string", "description":"The date the impact was confirmed.", "format":"date-time" }, "description":{ "type":"string", "description":"The impacted bucket's description." }, "item":{ "minItems":1, "type":"array", "description":"The impacted bucket items.", "items":{ "$ref":"#/components/schemas/ImpactedBucketItem" } }, "name":{ "type":"string", "description":"The impacted bucket's name." }, "requestedDate":{ "type":"string", "description":"The date the request was received.", "format":"date-time" } }, "description":"A bucket impacted by a balance top-up, adjustment, transfer, or reservation. " }, "ImpactedBucketItem":{ "type":"object", "properties":{ "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "description":"The object's subclass." }, "amount":{ "description":"The impact item's amount.", "$ref":"#/components/schemas/Quantity" }, "description":{ "type":"string", "description":"The impact item's description." }, "itemType":{ "type":"string", "description":"The impact item's type, indicating if the bucket is incremented (credit) or decremented (debit)." }, "name":{ "type":"string", "description":"The impact item's name, indicating the transaction activity. For example, top-up, bonus, additional bonus, tax, or fees." }, "reason":{ "type":"string", "description":"The reason for the impact item." } }, "description":"An impact item that affects an ImpactedBucket object." }, "AppliedBillingRateCharacteristic":{ "title":"Applied Billing Rate Characteristic", "required":[ "name", "value" ], "type":"object", "properties":{ "name":{ "title":"Characteristic Name", "type":"string", "description":"The characteristic's name." }, "valueType":{ "title":"Characteristic Type", "type":"string", "description":"The data type of the characteristic's value." }, "value":{ "$ref":"#/components/schemas/Any" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Scheme Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A characteristic of an applied billing rate, based on the service type, line of business, or other parameters." }, "AppliedBillingTaxRate":{ "title":"Applied Billing Tax Rate", "type":"object", "properties":{ "taxCategory":{ "title":"Tax Category", "type":"string", "description":"The applied billing tax's category." }, "taxRate":{ "title":"Tax Rate", "type":"number", "description":"The applied billing tax rate.", "format":"float" }, "taxAmount":{ "$ref":"#/components/schemas/Money" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"The tax rate applied to a billing rate." }, "AppliedCustomerBillingRate":{ "title":"Applied Customer Billing Rate", "required":[ "href", "id" ], "type":"object", "properties":{ "id":{ "title":"Applied Customer Billing Rate ID", "type":"string", "description":"The applied customer billing rate's ID." }, "href":{ "title":"Applied Customer Billing Rate Href", "type":"string", "description":"The applied customer billing rate's href." }, "date":{ "title":"Applied Customer Billing Rate Created Date", "type":"string", "description":"The date the applied customer billing rate was created.", "format":"date-time" }, "description":{ "title":"Description", "type":"string", "description":"The applied customer billing rate's description." }, "isBilled":{ "title":"Billed", "type":"boolean", "description":"Whether the applied customer billing rate has been billed (true) or not (false). If true, also provide a value for the bill property. If false, also provide a value for the billingAccount property." }, "name":{ "title":"Applied Customer Billing Rate Name", "type":"string", "description":"The applied customer billing rate's name." }, "type":{ "title":"Applied Billing Rate Type", "type":"string", "description":"The applied customer billing rate's type. For example, appliedBillingCharge (for recurring, one time, and usage charges), appliedBillingCredit (for rebates or product alteration credits), or appliedPenaltyCharge (for penalty charges like late fees or payment rejection fees.)" }, "appliedTax":{ "type":"array", "description":"The taxes applied to the applied customer billing rate.", "items":{ "$ref":"#/components/schemas/AppliedBillingTaxRate" } }, "bill":{ "$ref":"#/components/schemas/BillRef" }, "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "characteristic":{ "type":"array", "description":"The characteristics that define the applied customer billing rate.", "items":{ "$ref":"#/components/schemas/AppliedBillingRateCharacteristic" } }, "periodCoverage":{ "$ref":"#/components/schemas/TimePeriod" }, "product":{ "$ref":"#/components/schemas/ProductRef" }, "taxExcludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"An applied customer billing rate." }, "AppliedPayment":{ "title":"Applied Payment", "type":"object", "properties":{ "appliedAmount":{ "$ref":"#/components/schemas/Money" }, "payment":{ "$ref":"#/components/schemas/PaymentRef" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A payment that can be assigned to a bill." }, "Attachment":{ "title":"Attachment", "type":"object", "properties":{ "id":{ "title":"Attachment ID", "type":"string", "description":"The attachment's ID." }, "href":{ "title":"Attachment Href", "type":"string", "description":"The attachment's href." }, "attachmentType":{ "title":"Attachment Type", "type":"string", "description":"The attachment type. For example, video or picture." }, "content":{ "title":"Attachment Content", "type":"string", "description":"The attachment's base64 encoded content." }, "description":{ "title":"Attachment Description", "type":"string", "description":"The attachment's description." }, "mimeType":{ "title":"Mime Type", "type":"string", "description":"The attachment's mime type. For example, a file extension like jpeg or mp4." }, "name":{ "title":"Attachment Name", "type":"string", "description":"The attachment's name." }, "url":{ "title":"Attachment Link", "type":"string", "description":"A URL linking to the attachment content." }, "size":{ "$ref":"#/components/schemas/Quantity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"An attachment to an object." }, "AttachmentRef":{ "title":"Attachment Ref", "required":[ "id" ], "type":"object", "properties":{ "id":{ "title":"Attachment ID", "type":"string", "description":"The attachment reference's ID." }, "href":{ "title":"Attachment Href", "type":"string", "description":"The attachment reference's href." }, "description":{ "title":"Attachment Description", "type":"string", "description":"The attachment reference's description." }, "name":{ "title":"Attachment Name", "type":"string", "description":"The attachment reference's name." }, "url":{ "title":"Attachment Link", "type":"string", "description":"A URL linking to the attachment reference's content." }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." }, "@referredType":{ "title":"Referred Type", "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"An attachment reference." }, "AttachmentRefOrValue":{ "title":"Attachment Ref Or Value", "type":"object", "properties":{ "id":{ "title":"Attachment ID", "type":"string", "description":"The attachment reference's ID." }, "href":{ "title":"Attachment Href", "type":"string", "description":"The attachment reference's href." }, "attachmentType":{ "title":"Attachment Type", "type":"string", "description":"The attachment reference's type. For example, video or picture." }, "content":{ "title":"Attachment Content", "type":"string", "description":"The attachment's base64 encoded content." }, "description":{ "title":"Attachment Description", "type":"string", "description":"The attachment's description." }, "mimeType":{ "title":"Mime Type", "type":"string", "description":"The attachment's mime type. For example, a file extension like jpeg or mp4." }, "name":{ "title":"Attachment Name", "type":"string", "description":"The attachment's name." }, "url":{ "title":"Attachment Link", "type":"string", "description":"A URL linking to the attachment content." }, "size":{ "$ref":"#/components/schemas/Quantity" }, "validFor":{ "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." }, "@referredType":{ "title":"Referred Type", "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"An attachment reference or value. The baseType, type, schemaLocation and referredType properties are related to the contained object, not the AttchmentRefOrValue." }, "CustomerBill":{ "title":"Customer Bill", "required":[ "amountDue", "billDate", "href", "id", "paymentDueDate", "state" ], "type":"object", "properties":{ "id":{ "title":"Bill ID", "type":"string", "description":"The bill's ID." }, "href":{ "title":"Bill Href", "type":"string", "description":"The bill's href." }, "billDate":{ "title":"Bill Date", "type":"string", "description":"The date the bill was generated.", "format":"date-time" }, "billNo":{ "title":"Bill Number", "type":"string", "description":"The bill's number." }, "category":{ "title":"Bill Category", "type":"string", "description":"The bill's category. For example, normal, duplicate, interim, last." }, "lastUpdate":{ "title":"Bill Last Updated Date", "type":"string", "description":"The date that the bill was last updated.", "format":"date-time" }, "nextBillDate":{ "title":"Next Bill Date", "type":"string", "description":"The date the next bill will be generated.", "format":"date-time" }, "paymentDueDate":{ "title":"Payment Due Date", "type":"string", "description":"The bill's due date.", "format":"date-time" }, "runType":{ "title":"Bill Run Type", "type":"string", "description":"The way the bill was generated, either onCycle (a regular billing cycle run) or offCycle (an on-demand request. For example, if requested by the customer or if the account closes.)" }, "amountDue":{ "$ref":"#/components/schemas/Money" }, "appliedPayment":{ "type":"array", "description":"Payments applied to the bill.", "items":{ "$ref":"#/components/schemas/AppliedPayment" } }, "billDocument":{ "type":"array", "description":"A document attached to the bill.", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue" } }, "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "billingPeriod":{ "$ref":"#/components/schemas/TimePeriod" }, "financialAccount":{ "$ref":"#/components/schemas/FinancialAccountRef" }, "paymentMethod":{ "$ref":"#/components/schemas/PaymentMethodRef" }, "relatedParty":{ "type":"array", "description":"The parties related to the bill.", "items":{ "$ref":"#/components/schemas/RelatedPartyRef" } }, "remainingAmount":{ "$ref":"#/components/schemas/Money" }, "state":{ "$ref":"#/components/schemas/stateValue" }, "taxExcludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxIncludedAmount":{ "$ref":"#/components/schemas/Money" }, "taxItem":{ "type":"array", "description":"Taxes on the bill.", "items":{ "$ref":"#/components/schemas/TaxItem" } }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A customer bill, also called an invoice." }, "CustomerBill_Update":{ "title":"Customer Bill Update", "type":"object", "properties":{ "state":{ "$ref":"#/components/schemas/stateValue" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A customer bill, used in the bill update request when changing the bill's state." }, "CustomerBillOnDemand":{ "title":"Customer Bill OnDemand", "required":[ "billingAccount", "href", "id", "state" ], "type":"object", "properties":{ "id":{ "title":"Bill ID", "type":"string", "description":"The on-demand bill's ID." }, "href":{ "title":"Bill Href", "type":"string", "description":"The on-demand bill's href." }, "description":{ "title":"Bill Description", "type":"string", "description":"The on-demand bill's description." }, "lastUpdate":{ "title":"Last Updated Date", "type":"string", "description":"The date that the on-demand bill was last updated." }, "name":{ "title":"Bill Name", "type":"string", "description":"The on-demand bill's name." }, "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "customerBill":{ "$ref":"#/components/schemas/BillRef" }, "relatedParty":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "state":{ "$ref":"#/components/schemas/StateValues" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A customer bill created on demand." }, "CustomerBillOnDemand_Create":{ "title":"Customer Bill OnDemand Create", "required":[ "billingAccount" ], "type":"object", "properties":{ "description":{ "title":"Bill Description", "type":"string", "description":"The on-demand bill's description." }, "lastUpdate":{ "title":"Last Updated Date", "type":"string", "description":"The date that the on-demand bill was last updated." }, "name":{ "title":"Bill Name", "type":"string", "description":"The on-demand bill's name." }, "billingAccount":{ "$ref":"#/components/schemas/BillingAccountRef" }, "customerBill":{ "$ref":"#/components/schemas/BillRef" }, "relatedParty":{ "$ref":"#/components/schemas/RelatedPartyRef" }, "state":{ "$ref":"#/components/schemas/StateValues" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"An on-demand customer bill, used in the create request. The id and href properties are not used in the create request." }, "PaymentRef":{ "title":"Payment Ref", "required":[ "id" ], "type":"object", "properties":{ "id":{ "title":"Payment ID", "type":"string", "description":"The payment reference's ID." }, "href":{ "title":"Payment Href", "type":"string", "description":"The payment reference's href." }, "name":{ "title":"Payment Name", "type":"string", "description":"The payment reference's name." }, "amount":{ "$ref":"#/components/schemas/Money" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." }, "@referredType":{ "title":"Referred Type", "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A payment captured as a reference on an order. Used when a payment is made immediately on an order rather than at a later billing date." }, "Reference":{ "title":"Reference", "type":"object", "properties":{ "id":{ "title":"Reference ID", "type":"string", "description":"The reference's ID." }, "href":{ "title":"Reference Href", "type":"string", "description":"The reference's href." }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." }, "@referredType":{ "title":"Referred Type", "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"The general referencing resource schema." }, "RelatedPartyRef":{ "title":"Related Party Ref", "required":[ "id" ], "type":"object", "properties":{ "id":{ "title":"Related Party ID", "type":"string", "description":"The related party's ID." }, "href":{ "title":"Related Party Href", "type":"string", "description":"The related party's href." }, "name":{ "title":"Related Party Name", "type":"string", "description":"The related party's name." }, "role":{ "title":"Related Party Role", "type":"string", "description":"The related party's role." }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." }, "@referredType":{ "title":"Referred Type", "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "description":"A reference to the party related to an object." }, "StateValues":{ "title":"State Values", "type":"string", "description":"Possible values for an on-demand bill's state.", "enum":[ "inProgress", "rejected", "done", "terminatedWithError" ] }, "TaxItem":{ "title":"State Values", "type":"object", "properties":{ "taxCategory":{ "title":"Tax Category", "type":"string", "description":"The tax item's category." }, "taxRate":{ "title":"Tax Rate", "type":"number", "description":"The tax item's applied rate.", "format":"float" }, "taxAmount":{ "$ref":"#/components/schemas/Money" }, "@baseType":{ "title":"Base Type", "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "title":"Schema Location", "type":"string", "description":"A URI to a JSON schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "title":"Type", "type":"string", "description":"The object's subclass." } }, "description":"A tax item." }, "stateValue":{ "title":"State Value", "type":"string", "description":"Possible values for a bill's state.", "enum":[ "new", "partiallyPaid", "settled", "onHold", "inProgress" ] }, "AssociationSpecificationRef":{ "type":"object", "description":"A reference to an association specification.", "properties":{ "id":{ "type":"string", "description":"The association specification's ID." }, "href":{ "type":"string", "format":"uri", "description":"The association specification's href." }, "name":{ "type":"string", "description":"The association specification's name." }, "@baseType":{ "type":"string", "description":"The object's super-class." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships" }, "@type":{ "type":"string", "description":"The object's subclass." }, "@referredType":{ "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "required":[ "id" ] }, "CharacteristicRelationship":{ "type":"object", "description":"A related characteristic.", "properties":{ "id":{ "type":"string", "description":"The characteristic relationship's ID." }, "href":{ "type":"string", "format":"uri", "description":"The characteristic relationship's href." }, "relationshipType":{ "type":"string", "description":"The type of characteristic relationship." }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." } } }, "CharacteristicSpecification":{ "type":"object", "description":"A characteristic specification.", "properties":{ "id":{ "type":"string", "description":"The characteristic specification's ID." }, "configurable":{ "type":"boolean", "description":"Whether the characteristic is configurable (true) or not (false)." }, "description":{ "type":"string", "description":"The characteristic specification's description." }, "extensible":{ "type":"boolean", "description":"Whether the characteristic is extensible (true) or not (false)." }, "isUnique":{ "type":"boolean", "description":"Whether the characteristic is unique to the specification (true) or not (false)." }, "maxCardinality":{ "type":"integer", "description":"The maximum number of instances for a characteristic value." }, "minCardinality":{ "type":"integer", "description":"The minimum number of instances for a characteristic value." }, "name":{ "type":"string", "description":"The characteristic specification's name." }, "regex":{ "type":"string", "description":"A regular expression for derive the value of a characteristic." }, "valueType":{ "type":"string", "description":"The type of characteristic value." }, "charSpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecificationRelationship" }, "description":"A relationship between specification characteristics." }, "characteristicValueSpecification":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicValueSpecification" }, "description":"The list of possible attributes and values for the characteristic specification." }, "validFor":{ "description":"The time period for which the characteristic specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." }, "@valueSchemaLocation":{ "type":"string", "description":"A link to the schema describing the value type." } } }, "CharacteristicSpecificationRelationship":{ "type":"object", "description":"A relationship between characteristic specifications.", "properties":{ "id":{ "type":"string", "description":"The characteristic specification relationship's ID." }, "href":{ "type":"string", "format":"uri", "description":"The characteristic specification relationship's href." }, "characteristicSpecificationId":{ "type":"string", "description":"The ID of the target characteristic within the specification." }, "name":{ "type":"string", "description":"The name of the target characteristic within the specification." }, "parentSpecificationHref":{ "type":"string", "format":"uri", "description":"A link to the parent specification containing the target characteristic." }, "parentSpecificationId":{ "type":"string", "description":"The ID of the parent specification containing the target characteristic." }, "relationshipType":{ "type":"string", "description":"The type of characteristic specification relationship." }, "validFor":{ "description":"The time period for which the characteristic specification relationship is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." } } }, "CharacteristicValueSpecification":{ "type":"object", "description":"A specification of a value that can be assigned to a characteristic.", "properties":{ "isDefault":{ "type":"boolean", "description":"Whether the value is the default for the characteristic (true) or not (false)." }, "rangeInterval":{ "type":"string", "description":"Whether the valueFrom and valueTo attributes are included in the range of values or not. Use open to include both, closed to exclude both, closedBottom to exclude valueTo and closedTop to exclude valueFrom." }, "regex":{ "type":"string", "description":"A regular expression constraint for the value." }, "unitOfMeasure":{ "type":"string", "description":"The value's unit." }, "valueFrom":{ "type":"integer", "description":"The lowest value for the characteristic." }, "valueTo":{ "type":"integer", "description":"The highest value for the characteristic." }, "valueType":{ "type":"string", "description":"The type of value for the characteristic." }, "validFor":{ "description":"The time period for which the value is valid.", "$ref":"#/components/schemas/TimePeriod" }, "value":{ "description":"The value's schema.", "$ref":"#/components/schemas/Any" }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." } } }, "ConstraintRef":{ "type":"object", "description":"A reference to a constraint.", "properties":{ "id":{ "type":"string", "description":"The constraint's ID." }, "href":{ "type":"string", "format":"uri", "description":"The constraint's href." }, "name":{ "type":"string", "description":"The constraint's name." }, "version":{ "type":"string", "description":"The constraint's version." }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." }, "@referredType":{ "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "required":[ "id" ] }, "EntitySpecificationRelationship":{ "type":"object", "description":"A relationship between entity specifications.", "required":[ "relationshipType" ], "properties":{ "id":{ "type":"string", "description":"The entity specification relationship's ID." }, "href":{ "type":"string", "format":"uri", "description":"The entity specification relationship's href." }, "name":{ "type":"string", "description":"The entity specification relationship's name." }, "relationshipType":{ "type":"string", "description":"The entity specification relationship's type." }, "role":{ "type":"string", "description":"The entity specification's role." }, "associationSpec":{ "description":"The associated entity specification.", "$ref":"#/components/schemas/AssociationSpecificationRef" }, "validFor":{ "description":"The period of time for which the entity specification relationship is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." }, "@referredType":{ "type":"string", "description":"The object's type in the target system, if baseType and type need further disambiguation." } } }, "RatedProductUsage":{ "type":"object", "title":"Rated Product Usage", "description":"An instance of rated usage.", "properties":{ "ratingDate":{ "type":"string", "format":"date-time", "title":"Rating Date", "description":"The date the usage was rated." }, "usageRatingTag":{ "type":"string", "title":"Usage Rating Tag", "description":"The usage rating's tag." }, "isBilled":{ "type":"boolean", "title":"Is Billed", "description":"Whether the usage has been billed (true) or not (false)." }, "ratingAmountType":{ "type":"string", "title":"Rating Amount Type", "description":"The rating amount's type." }, "taxRate":{ "type":"number", "format":"float", "title":"Tax Rate", "description":"The tax rate." }, "isTaxExempt":{ "type":"boolean", "description":"Whether the usage is tax exempt (true) or not (false).", "title":"Is Tax Exempt" }, "offerTariffType":{ "type":"string", "title":"Offer Tariff Type", "description":"The tariff's type." }, "bucketValueConvertedInAmount":{ "title":"Bucket Value Converted In Amount", "description":"The rating amount, converted from a bucket value.", "$ref":"#/components/schemas/Money" }, "productRef":{ "title":"Product Ref", "description":"The product related to the rated product.", "$ref":"#/components/schemas/ProductRef" }, "taxExcludedRatingAmount":{ "title":"Tax Excluded Rating Amount", "description":"The rating amount, with tax excluded.", "$ref":"#/components/schemas/Money" }, "taxIncludedRatingAmount":{ "title":"Tax Included Rating Amount", "description":"The rating amount, with tax included.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "TargetEntitySchema":{ "type":"object", "description":"A reference to a target entity described by a specification.", "required":[ "@schemaLocation", "@type" ], "properties":{ "@schemaLocation":{ "type":"string", "description":"A link to the schema." }, "@type":{ "type":"string", "description":"The target entity's type." } } }, "Usage":{ "type":"object", "title":"Usage", "description":"A instance of usage.", "properties":{ "id":{ "type":"string", "title":"Usage ID", "description":"The usage's ID." }, "href":{ "type":"string", "format":"uri", "title":"Usage Href", "description":"The usage's href." }, "usageDate":{ "type":"string", "title":"Usage Date", "description":"The usage's date.", "format":"date-time" }, "usageType":{ "type":"string", "title":"Usage Type", "description":"The usage's type." }, "description":{ "type":"string", "title":"Usage Description", "description":"The usage's description" }, "status":{ "description":"The usage's status.", "$ref":"#/components/schemas/UsageStatusType" }, "usageSpecification":{ "description":"The usage's specification.", "$ref":"#/components/schemas/UsageSpecificationRef" }, "usageCharacteristic":{ "type":"array", "description":"The usage's characteristics.", "items":{ "$ref":"#/components/schemas/UsageCharacteristic" } }, "relatedParty":{ "type":"array", "description":"The parties related to the usage.", "items":{ "$ref":"#/components/schemas/RelatedParty" } }, "ratedProductUsage":{ "type":"array", "description":"The usage's rating details.", "items":{ "$ref":"#/components/schemas/RatedProductUsage" } }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." } } }, "UsageCharacteristic":{ "type":"object", "title":"Usage Characteristic", "description":"A characteristic of usage.", "properties":{ "id":{ "type":"string", "description":"The usage characteristic's ID." }, "name":{ "type":"string", "title":"Usage Characteristic Name", "description":"The characteristic's name." }, "valueType":{ "type":"string", "description":"The type of the characteristic's value." }, "characteristicRelationship":{ "type":"array", "description":"The characteristic's relationships.", "items":{ "$ref":"#/components/schemas/CharacteristicRelationship" } }, "value":{ "description":"The characteristic's value.", "$ref":"#/components/schemas/Any" }, "@baseType":{ "type":"string", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "description":"A URI to a JSON schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "description":"The object's subclass." } }, "required":[ "name", "value" ] }, "UsageSpecification":{ "type":"object", "title":"Usage Specification", "description":"A usage specification.", "properties":{ "id":{ "type":"string", "title":"Usage Specification ID", "description":"The usage specification's ID." }, "href":{ "type":"string", "title":"Usage Specification Href", "description":"The usage specification's href." }, "description":{ "type":"string", "title":"Usage Specification Description", "description":"The usage specification's description." }, "isBundle":{ "type":"boolean", "description":"Whether it is a bundle of specifications (true, or a single specification (false)." }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"Date and time that the specification was last updated." }, "lifecycleStatus":{ "type":"string", "description":"The specification's lifecycle status." }, "name":{ "type":"string", "title":"Usage Specification Name", "description":"The usage specification's name." }, "version":{ "type":"string", "description":"The usage specification's version." }, "attachment":{ "type":"array", "items":{ "$ref":"#/components/schemas/AttachmentRefOrValue" }, "description":"The usage specification's attachments." }, "constraint":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConstraintRef" }, "description":"The usage specification's constraints." }, "entitySpecRelationship":{ "type":"array", "items":{ "$ref":"#/components/schemas/EntitySpecificationRelationship" }, "description":"An entity specification relationship to another specification." }, "relatedParty":{ "type":"array", "items":{ "$ref":"#/components/schemas/RelatedParty" }, "description":"A party related to the usage specification." }, "specCharacteristic":{ "type":"array", "items":{ "$ref":"#/components/schemas/CharacteristicSpecification" }, "description":"The characteristics of the usage specification." }, "targetEntitySchema":{ "description":"The target entity described by the usage specification.", "$ref":"#/components/schemas/TargetEntitySchema" }, "validFor":{ "description":"The period of time for which the usage specification is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } } }, "UsageSpecificationRef":{ "type":"object", "title":"Usage Specification Ref", "description":"A usage specification reference.", "properties":{ "id":{ "type":"string", "title":"Usage Specification ID", "description":"The usage specification's ID." }, "href":{ "type":"string", "format":"uri", "title":"Usage Specification Href", "description":"The usage specification's href." }, "name":{ "type":"string", "title":"Usage Specification Name", "description":"The usage specification's name." }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "format":"uri", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships." }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The object's type in the target system, if baseType and type need further disambiguation." } }, "required":[ "id" ] }, "UsageStatusType":{ "type":"string", "title":"Usage Status", "description":"The usage's status.", "enum":[ "received", "rejected", "recycled", "guided", "rated", "rerated", "billed" ] }, "Payment":{ "required":[ "id", "href", "paymentDate", "totalAmount", "account", "paymentMethod", "status" ], "type":"object", "title":"Payment", "properties":{ "id":{ "type":"string", "title":"Payment ID", "description":"The payment's ID." }, "href":{ "type":"string", "title":"Payment Href", "description":"The payment's href." }, "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"An payment correlation ID from a client application." }, "description":{ "type":"string", "title":"Payment Description", "description":"The payment's description." }, "name":{ "type":"string", "title":"Payment Name", "description":"The payment's name." }, "paymentDate":{ "type":"string", "title":"Payment Date", "description":"The date the payment was made.", "format":"date-time" }, "status":{ "type":"string", "title":"Payment Status", "description":"The payment's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date the payment's status was recorded.", "format":"date-time" }, "account":{ "description":"An account related to the payment.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The payment's monetary amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The payment's channel.", "$ref":"#/components/schemas/ChannelRef" }, "payer":{ "description":"The party that made the payment.", "$ref":"#/components/schemas/RelatedParty" }, "paymentItem":{ "type":"array", "description":"Payment items which can be assigned to bills.", "items":{ "$ref":"#/components/schemas/PaymentItem" } }, "paymentMethod":{ "description":"The payment method.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "taxAmount":{ "description":"The amount of tax on the payment.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount on the payment.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment, including information about the payment, the payment amount, and the payment method." }, "Payment_Create":{ "required":[ "account", "paymentMethod", "totalAmount" ], "type":"object", "title":"Payment Create", "properties":{ "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"An payment correlation ID from a client application." }, "description":{ "type":"string", "title":"Payment Description", "description":"The payment's description." }, "name":{ "type":"string", "title":"Payment Name", "description":"The payment's name." }, "account":{ "description":"An account related to the payment.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The payment amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The payment channel.", "$ref":"#/components/schemas/ChannelRef" }, "payer":{ "description":"The party that made the payment.", "$ref":"#/components/schemas/RelatedParty" }, "paymentItem":{ "type":"array", "description":"Payment items which can be assigned to bills.", "items":{ "$ref":"#/components/schemas/PaymentItem" } }, "paymentMethod":{ "description":"The payment method. When the value of the payment method's @type property is PaymentMethodRef, the @referredType is also required, and valid values are tokenizedCard, bankAccountDebit, and bankCard.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "taxAmount":{ "description":"The amount of tax on the payment.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount on the payment.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment, used in payment create requests. The id, href, status, statusDate, and paymentDate properties aren't used in the create request." }, "PaymentItem":{ "required":[ "item" ], "type":"object", "title":"Payment Item", "properties":{ "id":{ "type":"string", "title":"Payment Item ID", "description":"The payment item's ID." }, "amount":{ "description":"The payment item amount.", "$ref":"#/components/schemas/Money" }, "item":{ "description":"A payment item entity.", "$ref":"#/components/schemas/EntityRef" }, "taxAmount":{ "description":"The amount of tax on the payment item.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total amount on the payment item.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A portion of a payment that can be assigned to a bill." }, "PaymentMethod":{ "type":"object", "title":"Payment Method", "properties":{ "id":{ "type":"string", "title":"Payment Method ID", "description":"The payment method's ID." }, "href":{ "type":"string", "title":"Payment Method Href", "description":"The payment method's href, used to retrieve more details about the payment method." }, "description":{ "type":"string", "title":"Payment Method Description", "description":"The payment method's description." }, "isPreferred":{ "type":"boolean", "title":"Payment Method Preferred", "description":"Whether this is the preferred payment method (true) or not (false)." }, "name":{ "type":"string", "title":"Payment Method Name", "description":"The payment method's name." }, "status":{ "type":"string", "title":"Status", "description":"The payment method's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date the payment method's status was recorded.", "format":"date-time" }, "account":{ "type":"array", "description":"Accounts associated with the payment method.", "items":{ "$ref":"#/components/schemas/AccountRef" } }, "relatedParty":{ "description":"The party associated with the payment method.", "$ref":"#/components/schemas/RelatedParty" }, "validFor":{ "description":"The time period for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A payment method." }, "PaymentMethodRefOrValue":{ "type":"object", "title":"Payment Method Ref Or Value", "properties":{ "id":{ "type":"string", "title":"Payment Method ID", "description":"The payment method's ID." }, "href":{ "type":"string", "title":"Payment Method Href", "description":"The payment method's href." }, "description":{ "type":"string", "title":"Payment Method Description", "description":"The payment method's description." }, "isPreferred":{ "type":"boolean", "title":"Payment Method Preferred", "description":"Whether this is the preferred payment method (true) or not (false)." }, "name":{ "type":"string", "title":"Payment Method Name", "description":"The payment method's name." }, "status":{ "type":"string", "title":"Status", "description":"The payment method's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date the payment method's status was recorded.", "format":"date-time" }, "account":{ "type":"array", "description":"Accounts associated with the payment method.", "items":{ "$ref":"#/components/schemas/AccountRef" } }, "relatedParty":{ "description":"The party associated with the payment method.", "$ref":"#/components/schemas/RelatedParty" }, "validFor":{ "description":"The time period for which the payment method is valid.", "$ref":"#/components/schemas/TimePeriod" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The payment method's type. Valid values are PaymentMethodRef for a credit or debit card, Cash, or Check. When the value is PaymentMethodRef, the payment method specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit will be used instead." }, "@referredType":{ "type":"string", "title":"Referred Type", "description":"The payment method's type, further refined from the @type value. To create a payment when @type is PaymentMethodRef, this is required, and valid values are tokenizedCard, bankAccountDebit, and bankCard." } }, "description":"A link to the resource containing information about the payment method.", "required":[ "id", "@type" ] }, "PaymentStatusExampleType":{ "type":"string", "title":"Payment Status Example Type", "description":"Examples of possible values for a payment's status.", "enum":[ "pendingAuthorization", "authorized", "captured", "failed", "canceled", "denied", "done" ] }, "PaymentAllocationRequestRefOracle":{ "title":"Payment Allocation Request Ref Oracle", "description":"A payment allocation request.", "type":"object", "properties":{ "paymentId":{ "type":"string", "title":"Payment Id", "description":"The ID of a payment to be allocated to a bill." }, "bill":{ "type":"array", "description":"The bill to which the payment is allocated.", "items":{ "$ref":"#/components/schemas/BillWisePaymentAllocationReqOracle" } } }, "required":[ "bill", "paymentId" ] }, "BillWisePaymentAllocationReqOracle":{ "title":"BillWise Payment Allocation Req Oracle", "description":"Bill information for a payment allocation request.", "type":"object", "properties":{ "id":{ "title":"Bill Id", "type":"string", "description":"The ID of the bill to which the payment is allocated." }, "allocatedAmount":{ "description":"The amount of the payment to allocate to the bill.", "$ref":"#/components/schemas/Money" } }, "required":[ "id", "allocatedAmount" ] }, "Refund":{ "required":[ "account", "paymentMethod" ], "type":"object", "title":"Refund", "properties":{ "id":{ "type":"string", "title":"Refund ID", "description":"The refund's ID." }, "href":{ "type":"string", "title":"Refund Href", "description":"The refund's href." }, "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"An refund correlation ID from a client application." }, "description":{ "type":"string", "title":"Refund Description", "description":"The refund's description." }, "name":{ "type":"string", "title":"Refund Name", "description":"The refund's name." }, "refundDate":{ "type":"string", "title":"Refund Date", "description":"The date when the refund was made.", "format":"date-time" }, "status":{ "type":"string", "title":"Refund Status", "description":"The refund's status." }, "statusDate":{ "type":"string", "title":"Status Date", "description":"The date when the refund's status was recorded.", "format":"date-time" }, "account":{ "description":"The account associated with the refund.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The refund amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The refund channel.", "$ref":"#/components/schemas/ChannelRef" }, "payment":{ "description":"The payment to be refunded.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the refund.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "requestor":{ "description":"The party requesting the refund.", "$ref":"#/components/schemas/RelatedParty" }, "taxAmount":{ "description":"The refund tax amount.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total refund amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A refund for a payment." }, "RefundCreate":{ "required":[ "account", "paymentMethod", "totalAmount" ], "type":"object", "title":"Refund Create", "properties":{ "authorizationCode":{ "type":"string", "title":"Authorization code", "description":"An authorization code from an external payment gateway." }, "correlatorId":{ "type":"string", "title":"correlator ID", "description":"An refund correlation ID from a client application." }, "description":{ "type":"string", "title":"Refund Description", "description":"The refund's description." }, "name":{ "type":"string", "title":"Refund Name", "description":"The refund's name." }, "refundDate":{ "type":"string", "title":"Refund Date", "description":"The date when the refund was made.", "format":"date-time" }, "account":{ "description":"The account associated with the refund.", "$ref":"#/components/schemas/AccountRef" }, "amount":{ "description":"The refund amount.", "$ref":"#/components/schemas/Money" }, "channel":{ "description":"The refund channel.", "$ref":"#/components/schemas/ChannelRef" }, "payment":{ "description":"The payment to be refunded.", "$ref":"#/components/schemas/PaymentRef" }, "paymentMethod":{ "description":"The payment method for the refund.", "$ref":"#/components/schemas/PaymentMethodRefOrValue" }, "requestor":{ "description":"The party requesting the refund.", "$ref":"#/components/schemas/RelatedParty" }, "taxAmount":{ "description":"The refund tax amount.", "$ref":"#/components/schemas/Money" }, "totalAmount":{ "description":"The total refund amount.", "$ref":"#/components/schemas/Money" }, "@baseType":{ "type":"string", "title":"Base Type", "description":"The object's superclass." }, "@schemaLocation":{ "type":"string", "title":"Schema Location", "description":"A URI to a JSON-Schema file that defines additional attributes and relationships.", "format":"uri" }, "@type":{ "type":"string", "title":"Type", "description":"The object's subclass." } }, "description":"A refund for a payment, used in the create refund request. The paymentMethod specified must be the one assigned to the bill unit. If you specify a different payment method, the one assigned to the bill unit will be refunded instead.

The id, href, status, statusDate, and refundDate properties are not used in the create request." }, "RefundStatusExampleType":{ "type":"string", "title":"Refund Status Example Type", "description":"Examples of possible values for a refund's status.", "enum":[ "pendingAuthorization", "authorized", "captured", "failed", "canceled", "denied", "done" ] }, "PaymentCreateEvent":{ "type":"object", "title":"Payment Create Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentCreateEventPayload" } }, "description":"An event for creating a payment." }, "PaymentCreateEventPayload":{ "type":"object", "title":"Payment Create Event Payload", "properties":{ "payment":{ "description":"The payment to create.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentCreateEvent." }, "PaymentAttributeValueChangeEvent":{ "type":"object", "title":"Payment Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentAttributeValueChangeEventPayload" } }, "description":"An event for changing a payment's attribute." }, "PaymentAttributeValueChangeEventPayload":{ "type":"object", "title":"Payment Attribute Value Change Event Payload", "properties":{ "payment":{ "description":"The payment with a changed attribute.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentAttributeValueChangeEvent." }, "PaymentStateChangeEvent":{ "type":"object", "title":"Payment State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentStateChangeEventPayload" } }, "description":"An event for changing a payment's state." }, "PaymentStateChangeEventPayload":{ "type":"object", "title":"Payment State Change Event Payload", "properties":{ "payment":{ "description":"The payment with the changed state.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentStateChangeEvent." }, "PaymentDeleteEvent":{ "type":"object", "title":"Payment Delete Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/PaymentDeleteEventPayload" } }, "description":"An event for deleting a payment." }, "PaymentDeleteEventPayload":{ "type":"object", "title":"Payment Delete Event Payload", "properties":{ "payment":{ "description":"The payment to delete.", "$ref":"#/components/schemas/Payment" } }, "description":"The payload for PaymentDeleteEvent." }, "RefundCreateEvent":{ "type":"object", "title":"Refund Create Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundCreateEventPayload" } }, "description":"An event for creating a refund." }, "RefundCreateEventPayload":{ "type":"object", "title":"Refund Create Event Payload", "properties":{ "refund":{ "description":"The refund to create.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundCreateEvent." }, "RefundAttributeValueChangeEvent":{ "type":"object", "title":"Refund Attribute Value Change Event", "properties":{ "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "fieldPath":{ "type":"string", "title":"Field Path", "description":"The path to the object that the event is about." }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundAttributeValueChangeEventPayload" } }, "description":"An event for changing a refund's attribute." }, "RefundAttributeValueChangeEventPayload":{ "type":"object", "title":"Refund Attribute Change Event Payload", "properties":{ "refund":{ "description":"The refund with the changed attribute.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundAttributeValueChangeEvent." }, "RefundStateChangeEvent":{ "type":"object", "title":"Refund State Change Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundStateChangeEventPayload" } }, "description":"An event for changing a refund's state." }, "RefundStateChangeEventPayload":{ "type":"object", "title":"Refund State Change Event Payload", "properties":{ "refund":{ "description":"The refund with the changed state.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundStateChangeEvent." }, "RefundDeleteEvent":{ "type":"object", "title":"Refund Delete Event", "properties":{ "id":{ "type":"string", "title":"Process ID", "description":"The state change process flow's ID." }, "href":{ "type":"string", "title":"Process Href", "description":"The state change process flow's href." }, "eventId":{ "type":"string", "title":"Event ID", "description":"The event's ID." }, "eventTime":{ "type":"string", "title":"Event Time", "description":"The event's time.", "format":"date-time" }, "eventType":{ "type":"string", "title":"Event Type", "description":"The event's type." }, "correlationId":{ "type":"string", "title":"Correlation ID", "description":"The event's correlation ID." }, "domain":{ "type":"string", "title":"Event Domain", "description":"The event's domain." }, "title":{ "type":"string", "title":"Event Title", "description":"The event's title." }, "description":{ "type":"string", "title":"Event Description", "description":"The event's description." }, "priority":{ "type":"string", "title":"Event Priority", "description":"The event's priority." }, "timeOcurred":{ "type":"string", "title":"Time Occurred", "description":"The time the event occurred.", "format":"date-time" }, "event":{ "description":"The event's payload.", "$ref":"#/components/schemas/RefundDeleteEventPayload" } }, "description":"An event for deleting a refund." }, "RefundDeleteEventPayload":{ "type":"object", "title":"Refund Delete Event Payload", "properties":{ "refund":{ "description":"The refund to delete.", "$ref":"#/components/schemas/Refund" } }, "description":"The payload for RefundDeleteEvent." } } }, "basepath":"/brm/usageManagement/v4" }