Create a Payment Allocation for a Bill
post
/paymentAllocation
Allocates a payment to the specified bill.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : Payment Allocation Request Ref Oracle
Type:
objectTitle:
Payment Allocation Request Ref OracleA payment allocation request.
Show Source
-
bill(required): array
bill
The bill to which the payment is allocated.
-
paymentId(required): string
Title:
Payment IdThe ID of a payment to be allocated to a bill.
Nested Schema : bill
Type:
arrayThe bill to which the payment is allocated.
Show Source
-
Array of:
object BillWise Payment Allocation Req Oracle
Title:
BillWise Payment Allocation Req OracleBill information for a payment allocation request.
Nested Schema : BillWise Payment Allocation Req Oracle
Type:
objectTitle:
BillWise Payment Allocation Req OracleBill information for a payment allocation request.
Show Source
-
allocatedAmount(required): object
Money
Title:
MoneyAn amount of money. -
id(required): string
Title:
Bill IdThe ID of the bill to which the payment is allocated.
Nested Schema : Money
Type:
objectTitle:
MoneyAn amount of money.
Show Source
-
unit: string
Title:
CurrencyAn ISO 4217 three letter currency code. -
value: number
(float)
Title:
AmountA positive floating point number.
Response
Supported Media Types
- application/json;charset=utf-8
201 Response
Payment allocation created successfully.
400 Response
Bad Request
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
401 Response
Unauthorized
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
403 Response
Forbidden
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
405 Response
Method Not allowed
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
409 Response
Conflict
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
500 Response
Internal Server Error
Root Schema : Error
Type:
objectTitle:
ErrorUsed when an API returns an error, typically with a HTTP error response-code such as 401 (Unauthorized) or 500 (Internal Server Error).
Show Source
-
@baseType: string
Title:
Base TypeThe object's superclass. -
@schemaLocation: string
(uri)
Title:
Schema LocationA URI to a JSON schema file that defines additional attributes and relationships. -
@type: string
Title:
TypeThe object's subclass. -
code(required): string
Title:
Error CodeAn application's error code, defined in the API or a common list. -
message: string
Title:
Error MessageMore details and corrective actions related to the error. -
reason(required): string
Title:
ReasonThe reason for the error. -
referenceError: string
(uri)
Title:
Reference ErrorA URI to documentation describing the error. -
status: string
Title:
Error StatusThe HTTP Error code extension
Examples
The following example shows how to create an allocation for an existing payment by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL.
The -d option specifies the file to attach as the request body.
curl -X POST 'http://host:port/brm/payment/version/paymentAllocation' -d @allocationCreate.json
The following is an example of the contents of the allocationCreate.json file sent as the request body.
{
"paymentId": "0.0.0.1+-item-payment+91630",
"bill": [
{
"id": "0.0.0.1+-bill+62437",
"allocatedAmount": {
"value": "50",
"unit": "USD"
}
}
]
}
When the allocation is created successfully, the only response is a 201 status code.