Finance

Retrieve a Invoice

Work with Invoices.Retrieves the Invoice with the given ID.

get/admin/finance/invoices/{id}

Request

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

Path parameters

idnumber double required

Example:1

The ID of the desired Invoice.

Response

customer_idnumber required

Customer ID

date_createdstring

Create date. Format: YYYY-MM-DD

date_updatedstring

Update date. Format: YYYY-MM-DD

date_tillstring

Pay till date. Format: YYYY-MM-DD

use_transactions'0' | '1'

Use transactions

notestring

Note

memostring

Memo

date_paymentstring

Payment date. Format: YYYY-MM-DD

statusstring required

Status. Values: 'not_paid' for "Not paid", 'paid' for "Paid", 'pending' for "Pending" and 'deleted' for "Deleted"

numberstring required

Number

payment_idnumber

Payment ID.

type'one_time' | 'recurring'

Type

payd_from_depositnumber

Set to 1 of invoice payd from deposit. Values: 0 or 1

is_sent'0' | '1'

Is sent

idnumber

Invoice ID

real_create_datetimestring

Real create date. Format: YYYY-MM-DD H:i:s

totalnumber

Total

duenumber

Due

added_by'system' | 'api' | 'admin'

Added by

added_by_idnumber

Added by ID

Example response

{
  "customer_id": 1,
  "date_created": "2016-01-01",
  "date_updated": "",
  "date_till": "",
  "use_transactions": "1",
  "note": "",
  "memo": "",
  "date_payment": "",
  "status": "not_paid",
  "number": "201601010003",
  "payment_id": 0,
  "type": "one_time",
  "payd_from_deposit": 0,
  "is_sent": "0",
  "items": [
    {
      "description": "Desc of item",
      "quantity": 1,
      "unit": 0,
      "price": 123,
      "tax": 0,
      "period_from": "2016-01-01",
      "period_to": "2016-01-02",
      "categoryIdForTransaction": 1,
      "sub_account_id": 0
    }
  ],
  "id": 1,
  "real_create_datetime": "2024-05-27 15:02:57",
  "total": 10,
  "due": 0,
  "added_by": "admin",
  "added_by_id": 1
}

Changes

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