Finance

Retrieve a Proforma invoice

Work with Proforma invoice.Retrieves the Proforma invoice with the given ID.

get/admin/finance/proforma-invoices/{id}

Request

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

Path parameters

idnumber double required
Example:1

The ID of the desired Proforma invoice.

Response

customer_idnumber required

Customer ID

date_createdstring

Create date. Format: YYYY-MM-DD

date_updatedstring

Last update. Format: YYYY-MM-DD

date_tillstring

Pay till date. Format: YYYY-MM-DD

date_paymentstring

Payment date. Format: YYYY-MM-DD

statusstring required

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

numberstring required

Number

payment_idnumber

Payment ID.

idnumber

Request ID

Example response

{
  "customer_id": 1,
  "date_created": "2016-01-01",
  "date_updated": "",
  "date_till": "",
  "date_payment": "",
  "status": "not_paid",
  "number": "201601010003",
  "payment_id": 0,
  "items": [
    {
      "description": "Desc of item",
      "quantity": 1,
      "unit": 0,
      "price": 123,
      "tax": 0,
      "period_from": "2016-01-01",
      "period_to": "2016-01-02",
      "sub_account_id": 0
    }
  ],
  "id": 1
}

Changes

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