Field guide

The following fields are available in a letter object

NameTypeExampleNotes
idint43Letter id
client_idint1Client's id
client_namestringJane DoeName of client
client_address_idint1Client's address id
client_contact_idint0Client's contact id
datedate2012-03-25Date of letter
titlestringMy letterTitle of the letter
statusint7Status Types
pagesint2Number of pages

Example content of data variable:

    {
        "error":false,
        "item":{
            "id":2,
            "client_id":16,
            "client_address_id":11,
            "client_contact_id":0,
            "date":"2013-02-25",
            "title":"Letter to Jane Doe",
            "status":7,
            "pages":1
        }
    }
    

Status

StatusMeaning of status
1Sent / Open
7Draft