You can list your available offers with the following URL:

                GET https://api.smallinvoice.com/offer/list/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
limitintno0Limit the amount of results
pageintno1When limiting the results, specifies page
sortstringnodatedate
due
number
Sorts the list by the available values
sorttypestringnodescasc
desc
Defines the way of sorting


Example: Making a request with 100 Results, getting second page, and sorting by date ascending

        GET https://api.smallinvoice.com/offer/list/limit/100/page/2/sort/date/sorttype/asc/
    

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.
pageintCurrent page that was passed in on the request
pagesintTotal number of pages available
countintTotal number of objects available
itemscollectionCollection of Offer Objects

Example content of data variable:

    {
        "error":false,
        "page":1,
        "pages":1,
        "count":1,
        "items":[
            {
                "id":4,
                "number":10000,
                "client_id":16,
                "client_name":"Jane Doe",
                "client_address_id":11,
                "client_contact_id":0,
                "currency":"CHF",
                "title":"Offerte Nr. {3} \/ Kunden Nr. {2}",
				"period":"",
                "date":"2013-02-25",
                "due":"2013-03-07",
                "discount":0,
                "discount_type":0,
                "conditions":"",
                "introduction":"",
                "language":"de",
                "acceptonline":0,
                "vat_included":0,
                "totalamount":0,
                "status":7,
                "pages":1,
                "positions":[
                    {
                        "type":1,
                        "number":null,
                        "name":"Service Y",
                        "description":"Cleaning house",
                        "cost":0,
                        "unit":1,
                        "amount":1,
                        "vat":8,
                        "discount":null
                    },
                    {
                        "type":2,
                        "number":null,
                        "name":"Product X",
                        "description":"Repairing car",
                        "cost":0,
                        "unit":7,
                        "amount":1,
                        "vat":8,
                        "discount":null
                    }
                ]
            }
        ]
    }
    

You can get your offer with the following URL:

                GET https://api.smallinvoice.com/offer/get/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer


Example: Making a request for offer with id 5

                GET https://api.smallinvoice.com/offer/get/id/5
            

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.
itemobjectObject of Offer

Example content of data variable:

    {
        "error":false,
        "item":{
            "id":4,
            "number":10000,
            "client_id":16,
            "client_name":"John Doe",
            "client_address_id":11,
            "client_contact_id":0,
            "currency":"CHF",
            "title":"Offerte Nr. {OFFERTENNR} \/ Kunden Nr. {KUNDENNR}",
			"period":"",
            "date":"2013-02-25",
            "due":"2013-03-07",
            "discount":0,
            "discount_type":0,
            "conditions":"",
            "introduction":"",
            "language":"de",
            "acceptonline":0,
            "vat_included":0,
            "totalamount":0,
            "status":7,
            "pages":1,
            "positions":[
                {
                    "type":1,
                    "number":null,
                    "name":"Service Y",
                    "description":"Cleaning house",
                    "cost":0,
                    "unit":1,
                    "amount":1,
                    "vat":8,
                    "discount":null
                },
                {
                    "type":2,
                    "number":null,
                    "name":"Product X",
                    "description":"Repairing car",
                    "cost":0,
                    "unit":7,
                    "amount":1,
                    "vat":8,
                    "discount":null
                }
            ]
        }
    }
    

You can get your offer as pdf with the following URL:

                GET https://api.smallinvoice.com/offer/pdf/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer


Example: Making a request for offer with id 5

                GET https://api.smallinvoice.com/offer/pdf/id/5
            

Response

NameTypeNotes
HTTP Bodyapplication/pdfThe PDF in raw format

You can get a offer preview in PNG form for each page of a document with the following URL:

                GET https://api.smallinvoice.com/offer/preview/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer
pageintno1The page you want to retreive
sizeintno595240
595
600
972
1240
The size in pixels


Example: Getting second page in size 1240 for offer with id 5

                GET https://api.smallinvoice.com/offer/preview/id/5/page/2/size/1240
            

Response

NameTypeNotes
HTTP Bodyimage/pngThe image in raw format

You can add a new offer with the following URL:

                POST https://api.smallinvoice.com/offer/add
            

Body parameters

NameTypeRequiredDefaultNotes
numberstringnoNext higher numberYour offer number
client_idintyesClient's id
client_address_idintyesClient's address id
client_contact_idintno0Client's contact id
currencystringyesThree-letter currency code
titlestringnoTitle of the offer
periodstringno
datedateyesDate of offer
duedateyesLatest payment date
discountfloatno0Discount amount
discount_typeintno0See Discount Types
introductionstringnoIntroduction text printed above positions
conditionsstringnoText printed below positions
languagestringyesTwo-letter language code
acceptonlineintno0Enabling feature to accept online offers
vat_includedintno0If VAT is included in positions' prices
positionscollectionyesCollection of Position Objects


Example: Creating a new offer

                POST https://api.smallinvoice.com/offer/add/
            

Example content of data variable:
{
    "number":10000,
    "client_id":16,
    "client_name":"John Doe",
    "client_address_id":11,
    "client_contact_id":0,
    "currency":"CHF",
    "title":"Offerte Nr. {OFFERTENNR} \/ Kunden Nr. {KUNDENNR}",
	"period":"",
    "date":"2013-02-25",
    "due":"2013-03-07",
    "discount":0,
    "discount_type":0,
    "conditions":"",
    "introduction":"",
    "language":"de",
    "acceptonline":0,
    "vat_included":0,
	"positions":[
	{
		"type":2,
		"number":null,
		"name":"Product X",
		"description":"Repairing car",
		"cost":0,
		"unit":1,
		"amount":1,
		"vat":8,
		"discount":null
	},
	{
		"type":1,
		"number":null,
		"name":"Service Y",
		"description":"Cleaning house",
		"cost":0,
		"unit":7,
		"amount":1,
		"vat":8,
		"discount":null
	}
	]
}

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.
idintThe Id of the Offer Object that was created

Example response:

    {
        "error":false,
        "id": 43
    }
    

You can edit an offer with the following URL:

                POST https://api.smallinvoice.com/offer/edit
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer

Body parameters

NameTypeNotes
numberstringYour offer number
client_idintClient's id
client_address_idintClient's address id
client_contact_idintClient's contact id
currencystringThree-letter currency code
titlestringTitle of the offer
periodstring
datedateDate of offer
duedateLatest payment date
discountfloatDiscount amount
discount_typeintSee Discount Types
introductionstringIntroduction text printed above positions
conditionsstringText printed below positions
languagestringTwo-letter language code
acceptonlineintEnabling feature to accept online offers
vat_includedintIf VAT is included in positions' prices
positionscollectionCollection of Position Objects


Example: Editing an offer with id 5

                POST https://api.smallinvoice.com/offer/edit/id/5
            

Example content of data variable:
{
    "number":10000,
    "client_id":16,
    "client_name":"Jane Doe",
    "client_address_id":11,
    "client_contact_id":0,
    "currency":"CHF",
    "title":"Offerte Nr. {OFFERTENNR} \/ Kunden Nr. {KUNDENNR}",
	"period":"",
    "date":"2013-02-25",
    "due":"2013-03-07",
    "discount":0,
    "discount_type":0,
    "conditions":"",
    "introduction":"",
    "language":"de",
    "acceptonline":0,
    "vat_included":0,
}

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }
    

You can delete an offer with the following URL:

                POST https://api.smallinvoice.com/offer/delete/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer


Example: Making a request for deleting offer with id 5

                POST https://api.smallinvoice.com/offer/delete/id/5
            

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }
    

You can email your offer with the following URL:

                POST https://api.smallinvoice.com/offer/email
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer

Body parameters

NameTypeRequiredDefaultNotes
subjectstringYesSubject of email
bodystringYesContent of the email
afterstatusintNoThe status the document should take after sending
recipientscollectionYesList of recipients. See example


Example: Sending an offer with id 5 via email

                POST https://api.smallinvoice.com/offer/email/id/5
            

Example content of data variable
{
  "subject" : "Email subject",
  "body" : "Email body",
  "afterstatus" : 1,
  "recipients" : [
      {
        "cc" : false,
        "email" : "email@domain.com",
        "name" : "Client Name"
      }
    ]
}
     

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }
    

You can send your offer via postmail with the following URL:

                POST https://api.smallinvoice.com/offer/post
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer

Body parameters

NameTypeRequiredDefaultNotes
speedintYes1 = Priority / 2 = Economy
colorintNo00 = B/W / 1 = Color
sendstatusintNoThe status the document should be sent in
afterstatusintNoThe status the document should take after sending


Example: Sending an offer with id 5 via postmail

                POST https://api.smallinvoice.com/offer/post/id/5
            

Example content of data variable
{
  "afterstatus" : 1,
  "sendstatus" : 1,
  "speed" : 1
}
     

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }
    

You can change status of your offer with the following URL:

                POST https://api.smallinvoice.com/offer/status/
            

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the offer

Body parameters

NameTypeRequiredDefaultNotes
statusintYesSee Status Types


Example: Making a request for offer with id 5

                POST https://api.smallinvoice.com/offer/status/id/5
            

Example content of data variable
{
  "status" : 1
}
     

Response

NameTypeNotes
errorbooleanIs true if an error occured
errorcodeintCode of the error. Only returned if error is true.
errormessagestringInformational message about the error. Only returned if error is true.

Example response:

    {
        "error":false
    }