Octane REST API
  1. Transaction
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
        GET
      • Make Payment
        POST
      • Add Misc Adjustment
        POST
      • List Bounced Transactions
        GET
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. Transaction

Add Misc Adjustment

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
POST
https://benzine.telcoinabox.com/tiab/api
/v1/group/{groupno}/customer/{custno}/transaction/adjustment
transaction
This API will be used to list transactions added against a customer account, which can include Payments, Refunds, and Misc Credit/Debits

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
groupno
string 
required
Group Number. Users will have access only to specific Groups and must pass this ID when accessing any Resources via API.
custno
string 
required
Customer Number. Specify the Customer Resource to make the operation against.
Body Params application/json
transactionType
enum<string> 
required
The type of Transaction to add
Allowed values:
MCMD
miscAdjustmentType
string 
required
The type of misc adjustment type added
comment
string 
required
Description of the transaction being added
transactionDate
string <date>
required
The datetime that the transaction was made
totalAmount
number <double>
required
Total amount of adjustment to make
Example
{
    "transactionType": "MC",
    "miscAdjustmentType": "string",
    "comment": "string",
    "transactionDate": "2019-08-24",
    "totalAmount": 0
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://benzine.telcoinabox.com/tiab/api/v1/group//customer//transaction/adjustment' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "transactionType": "MC",
    "miscAdjustmentType": "string",
    "comment": "string",
    "transactionDate": "2019-08-24",
    "totalAmount": 0
}'

Responses

🟢200OK
application/json
Body
custNo
integer 
required
Octane Customer Number
tranNo
integer 
required
Unique identifer of the transaction for this Customer Account
transactionType
enum<string> 
required
The type of transaction that was made.
Allowed values:
PMCMDBCCRD
paymentMethod
enum<string> 
optional
The type of payment method for a payment
Allowed values:
APBABPCCCHNPPD
creditCardType
enum<string> 
optional
The type of credit card used for a payment
Allowed values:
AXDIMAVI
miscAdjustmentType
enum<string> 
optional
The type of misc adjustment type added
Allowed values:
A0A1A2A4A9BB1CAEBF2ICIDMHMMMRO9OCOIOKOLOXP0P1P2RDRFRYSCTPVIVPWH
comment
string 
optional
Description of the transaction being added
transactionDate
string <date-time>
required
The datetime that the transaction was made
stmtNo
integer 
optional
The statement no that this payment was allocated to
principalAmount
number <double>
required
Amount before any surcharge added
surchargeAmount
number <double>
optional
Amount of surcharge. Surcharge will only be returned for P transactions (if applicable).
taxAmount
number <double>
optional
Amount of tax applied to this transaction. Tax will only be returned for CC transactions.
totalAmount
number <double>
required
Total amount of transaction. Principal amount plus surcharge/tax
currency
enum<string> 
required
The currency that the transaction is in
Allowed value:
AUD
dateAdded
string <date-time>
optional
Timestamp of when the transaction was added.
userAdded
string 
optional
Timestamp of the user that added the transaction
Example
{
    "custNo": 0,
    "tranNo": 0,
    "transactionType": "P",
    "paymentMethod": "AP",
    "creditCardType": "AX",
    "miscAdjustmentType": "A0",
    "comment": "string",
    "transactionDate": "2019-08-24T14:15:22Z",
    "stmtNo": 0,
    "principalAmount": 0,
    "surchargeAmount": 0,
    "taxAmount": 0,
    "totalAmount": 0,
    "currency": "AUD",
    "dateAdded": "2019-08-24T14:15:22Z",
    "userAdded": "string"
}
🟠403Invalid access
🟠400Invalid input
🟠404Customer not found
Modified at 2024-03-25 18:39:04
Previous
Make Payment
Next
List Bounced Transactions
Built with