Finance

Retrieve a Transaction

Work with Transactions.Retrieves the Transaction with the given ID.

get/admin/finance/transactions/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/finance/transactions/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Transaction.

Response

typestring required

Type. Values: 'debit' for "+ Income" or 'credit' for "- Charge"

customer_idnumber required

Customer ID

quantitynumber

Quantity. Default: 1

unitstring

Unit

pricenumber

Price

tax_percentnumber required

VAT %

remind_amountnumber

Remind amount

datestring required

Date. Format: YYYY-MM-DD

categorystring required

Category ID. You can get it on page "Config / Finance / Transaction categories"

descriptionstring

Description

period_fromstring

Begin of period. Format: YYYY-MM-DD

period_tostring

End of period. Format: YYYY-MM-DD

service_idnumber nullable

Service ID

payment_idnumber nullable

Payment ID

credit_note_idnumber

Credit note ID

invoice_idnumber nullable

Invoice ID

invoiced_by_idnumber nullable

Invoiced by ID

commentstring

Comment

to_invoiceboolean

To invoice. Default: false

service_type'internet' | 'voice' | 'custom' | 'bundle' | 'one_time'

Service type

source'manual' | 'auto' | 'cdr' | 'config'

Source

tax_idnumber

Tax ID

sub_account_idnumber

ID of the sub-account this transaction is associated with. Used for aggregated billing.

idnumber

Transaction ID

totalnumber

Total

Example response

{
  "type": "debit",
  "customer_id": 1,
  "quantity": 1,
  "unit": "",
  "price": 158.25,
  "tax_percent": 19,
  "remind_amount": 0,
  "date": "2016-01-01",
  "category": "1",
  "description": "Description",
  "period_from": "",
  "period_to": "",
  "service_id": null,
  "payment_id": null,
  "credit_note_id": 0,
  "invoice_id": null,
  "invoiced_by_id": null,
  "comment": "",
  "to_invoice": false,
  "service_type": "internet",
  "source": "manual",
  "tax_id": 1,
  "sub_account_id": 0,
  "id": 1,
  "total": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.