v1

latestOpenAPI 3.1.02026-07-241210356.3 KB

Invoice+ - Documents

Get document by Number

get/books/docs/getBy/number/{number}/{series}

Path parameters

numberstring required

Numerical part of the doc number

seriesstring required

Alphabetical number prefix, if applicable

Headers

api-keystring required

API Key

secret-keystring required

Secret Key

Response

200

barcodestring

copyDocAddressstring

currency_codestring

customer_uuidstring

docUIDstring

doc_datestring

doc_typestring

{"stackTrail":"paths:/books/docs/getBy/number/{number}/{series}:get:responses:200:content:application/json:schema:properties:more_info","oasType":"schema","type":"unknown"}

numberstring

originalDocAddressstring

total_items_base_currencyinteger

validDocumentGeneratedboolean

Example response

{
  "barcode": "472819632332439",
  "brand": {
    "name": "Company Name",
    "uuid": "67a8cc93-75ac-4832-8386-3eb5b24bf3d0"
  },
  "copyDocAddress": "https://restapi.payplus.co.il/getdoc/s/c/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
  "currency_code": "ILS",
  "customer": {
    "customer_name": "John Doe",
    "email": "johndoe@example.com",
    "phone": "123456789",
    "subject_code": "987654321",
    "uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
    "vat_number": "1231231"
  },
  "customer_uuid": "faa6280f-dba5-4889-9b15-de60e1527bdc",
  "docUID": "1fa79282-61d1-4898-b7b9-afa67f46d34a",
  "doc_date": "2022-11-15",
  "doc_type": "inv_tax",
  "number": "SCP/50042",
  "originalDocAddress": "https://restapi.payplus.co.il/getdoc/s/o/1fa79282-61d1-4898-b7b9-afa67f46d34a.pdf",
  "total_items_base_currency": 150,
  "validDocumentGenerated": true
}