Read and write records

List, read, create, update and delete any record you are allowed to.

Every record type in Prospera Books, such as Customer, Item, Sales Invoice or Payment Entry, has the same four operations at /api/resource/. Record type names are written as they appear in Prospera Books, with spaces encoded as %20.

1. List records

   GET /api/resource/Customer?fields=["name","customer_name"]&filters=[["customer_group","=","Commercial"]]&limit_page_length=20
   
   {"data": [{"name": "CUST-0001", "customer_name": "Delta Hotels"}]}

2. Read one record

   GET /api/resource/Customer/CUST-0001
   
   {"data": {"name": "CUST-0001", "customer_name": "Delta Hotels", ...}}

3. Create a record

   Send the fields as JSON in the body.

   POST /api/resource/Customer
   Content-Type: application/json
   
   {"customer_name": "Sinai Resorts", "customer_type": "Company"}

4. Update a record

   Send only the fields you change.

   PUT /api/resource/Customer/CUST-0001
   Content-Type: application/json
   
   {"mobile_no": "+20 100 000 0000"}

5. Delete a record

   DELETE /api/resource/Customer/CUST-0001

6. Read the response

   Successful calls return JSON with the record or list in data. Errors return an HTTP error status with a message you can show to the person running the integration.