You can list your available accounts with the following URL:

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

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 Account Objects

Example content of data variable:

    {
        "error":false,
        "page":1,
        "pages":1,
        "count":1,
        "items":[
            {
                "id":1,
                "title":"John & Jane Doe Account",
                "institute":"ACME AG",
                "number":"0123456789",
                "iban":"0123456789",
                "swiftbic":"0123456789",
                "clearing":"0123456789",
                "postaccount":"0123456789"
            }
        ]
    }
    

You can get your account with the following URL:

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

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 Account

Example content of data variable:

    {
        "error":false,
        "item":{
            "id":1,
            "title":"John & Jane Doe Account",
            "institute":"ACME AG",
            "number":"0123456789",
            "iban":"0123456789",
            "swiftbic":"0123456789",
            "clearing":"0123456789",
            "postaccount":"0123456789"
        }
    }
    

You can add a new account with the following URL:

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

Body parameters

NameTypeRequiredDefaultNotes
titlestringyes
institutestringyes
swiftbicstringyes
clearingstringyes


Example: Creating a new account

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

Example content of data variable:
{
    "title":"John & Jane Doe Account",
    "institute":"ACME AG",
    "number":"0123456789",
    "iban":"0123456789",
    "swiftbic":"0123456789",
    "clearing":"0123456789",
    "postaccount":"0123456789"
}

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 Account Object that was created

Example response:

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

You can edit an account with the following URL:

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

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the account

Body parameters

NameTypeNotes
titlestring
institutestring
swiftbicstring
clearingstring


Example: Editing an account with id 5

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

Example content of data variable:
{
    "title":"John & Jane Doe Account",
    "institute":"ACME AG",
    "number":"0123456789",
    "iban":"0123456789",
    "swiftbic":"0123456789",
    "clearing":"0123456789",
    "postaccount":"0123456789"
}

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 account with the following URL:

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

URL Parameters

NameTypeRequiredDefaultOptionsNotes
idintyesThe Id of the account


Example: Making a request for deleting account with id 5

                POST https://api.smallinvoice.com/account/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
    }