Zenconomy Invoicing and Accounting API reference

To test run API calls from within documentation, get your test API key here

API Key

Shared Secret

Authenticated with OAuth

• Invoicing - Invoice (faktura)

  • List Methods
  • Expand Methods

  • GETGet/invoice/get
    Get invoice
    
    

    Parameter	Value	Type	Description
    invoice_id		int

  • GETList/invoice/list
    List invoices
    
    

    Parameter	Value	Type	Description
    query		string	Search query to limit results

  • GETExport PDF/invoice/export
    Open or download invoice in PDF format
    
    

    Parameter	Value	Type	Description
    output	browserdownload	enumerated	Open file in browser or download it (content-disposition)
    invoice_id		int

  • GETSend as email/invoice/export
    Send invoice as email with link to PDF. Emails are NOT sent from the Sandbox.
    
    

    Parameter	Value	Type	Description
    output	email	enumerated
    invoice_id		int
    email_from		string
    email_to		string
    message		string

  • GETSend as letter (snail mail)/invoice/export
    Send invoice as letter in the mail. Fully automated, letter is posted within 24 hours. Cost 12 SEK/letter. Letters are NOT sent from the Sandbox.
    
    

    Parameter	Value	Type	Description
    output	letter	enumerated
    invoice_id		int
    address1		string	Not required if invoice customer has this value
    address2		string
    city		string	Not required if invoice customer has this value
    postalcode		string	Not required if invoice customer has this value
    country		string

  • POSTCreate/invoice/create

    Relations

    • An invoice requires a contact and one or more articles.

    Accounting Hooks

    • When an invoice is flagged as sent (by setting the invoice.status_sent parameter or the command invoice/export), a related unlocked record is automatically created. When this record is locked with the call record/lock, the invoice.status_accounted flag will be set to TRUE and the invoice can no longer be updated.
    • When an invoice is cancelled, a related unlocked record will be deleted. If the related record is locked, an unlocked cancellation record will be created.

    
    
    

    Parameter	Value	Type	Description
    issue_date		date	Date the invoice is issued, yyyy-mm-dd
    due_date		date	Date the invoice is due to be paid, yyyy-mm-dd
    customer_id		int	ID for related Contact (customer)
    invoice_number		int	Must be higher than previously highest invoice number. Will be calculated automatically by auto-increment if omitted
    reference		string	Customer reference info, displayed on invoice
    our_reference		string	Seller reference info, displayed on invoice
    notes		string	Notes, not displayed on invoice
    status_sent	10	boolean	Flag the invoice as sent
    type	standardrotrut	enumerated
    row[0][article_id]		int	ID for related Article
    row[0][article_name]		string	Article name
    row[0][text]		string	Article description
    row[0][quantity]		int	Quantity in 1/100ths, 200 = 2 items
    row[0][price]		int	Price in 1/100ths of currency, 1550 = 15.50
    row[0][tax_rate]		int	Tax rate in 1/100ths, 2500 = 25%

  • POSTUpdate/invoice/update
    Update invoice
    
    

    Parameter	Value	Type	Description
    invoice_id		int
    issue_date		date	Date the invoice is issued, yyyy-mm-dd
    due_date		date	Date the invoice is due to be paid, yyyy-mm-dd
    customer_id		int	ID for related Contact (customer)
    invoice_number		int	Will be calculated automatically by auto-increment if omitted
    reference		string	Customer reference info, displayed on invoice
    our_reference		string	Seller reference info, displayed on invoice
    notes		string	Private notes, not displayed on invoice
    row[0][article_id]		int	ID for related Article
    row[0][article_name]		string	Article name
    row[0][text]		string	Row description
    row[0][quantity]		int	Quantity in 1/100ths, 200 = 2 items
    row[0][price]		int	Price in 1/100ths, 1550 = 15,50 kr
    row[0][tax_rate]		int	Tax rate in 1/100ths, 2500 = 25%

  • POSTCancel/invoice/cancel
    Cancel an invoice (makulera)
    
    

    Parameter	Value	Type	Description
    invoice_id		int

• Invoicing - Article (artikel)

  • List Methods
  • Expand Methods

  • GETGet/article/get
    Get article
    
    

    Parameter	Value	Type	Description
    article_id		int

  • GETList/article/list
    List articles
    
    

    Parameter	Value	Type	Description
    query		string	Search query to limit results

  • POSTCreate/article/create
    Create article
    
    

    Parameter	Value	Type	Description
    number		string	Article number (not to be confused with article_id)
    name		string
    price		int	Price in 1/100ths of currency, 1550 = 15.50
    tax_rate		int	Tax rate in 1/100ths, 2500 = 25%
    type	productsservices	enumerated

  • POSTUpdate/article/update
    Update article
    
    

    Parameter	Value	Type	Description
    article_id		int
    number		string	Article number (not to be confused with article_id)
    name		string
    price		int	Price in 1/100ths of currency, 1550 = 15.50
    tax_rate		int	Tax rate in 1/100ths, 2500 = 25%
    type	productsservices	enumerated

  • POSTDelete/article/delete
    Delete an article
    
    

    Parameter	Value	Type	Description
    article_id		int

• Invoicing - Payment (betalning)

  • List Methods
  • Expand Methods

  • GETGet/payment/get
    Get payment
    
    

    Parameter	Value	Type	Description
    payment_id		int

  • GETList/payment/list
    List payments
    
    

    Parameter	Value	Type	Description
    query		string	Search query to limit results

  • POSTCreate/payment/create

    Relations

    • A payment requires an invoice.

    Accounting Hooks

    • When a payment is created, a related accounting record is automatically created. If this record is locked with the call record/lock, the status_accounted flag will be set to TRUE and the payment can no longer be updated or deleted.

    
    
    

    Parameter	Value	Type	Description
    invoice_id		int	ID for related Invoice
    transactionaccount_id		int	ID for related Transactionaccount
    payment_date		date	Date the payment was made, yyyy-mm-dd
    amount		int	Amount paid in 1/100ths of currency, 1550 = 15.50

  • POSTDelete/payment/delete
    Delete a payment
    
    

    Parameter	Value	Type	Description
    payment_id		int

• Accounting - Record (verifikat)

  • List Methods
  • Expand Methods

  • GETGet/record/get
    Get record
    
    

    Parameter	Value	Type	Description
    record_id		int

  • GETList/record/list
    List records
    
    

    Parameter	Value	Type	Description
    start		date	Start of date range
    end		date	End of date range
    query		string	Search query to limit results

  • POSTCreate/record/create
    Records must have a minimum of two rows, and the sum of the amounts for all rows must be equal to zero.
    
    

    Parameter	Value	Type	Description
    transaction_date		date	Date the transaction occurred, yyyy-mm-dd
    text		string	Textual description
    row[0][account]		int	Account number (not to be confused with account_id)
    row[0][amount]		string	Amount in 1/100ths of currency, 2500 = 25.00, -7550 = -75.50

  • POSTUpdate/record/update
    Update record
    
    

    Parameter	Value	Type	Description
    record_id		int
    transaction_date		date	Date the transaction occurred, yyyy-mm-dd
    text		string	Textual description
    row[0][account]		int	Account number (not to be confused with account_id)
    row[0][amount]		string	Amount in 1/100ths of currency, 2500 = 25.00, -7550 = -75.50

  • POSTLock/record/lock
    Lock record so it can no longer be updated or deleted - record.locked must be false
    
    

    Parameter	Value	Type	Description
    record_id		int

  • POSTDelete/record/delete
    Delete record - record.locked must be false
    
    

    Parameter	Value	Type	Description
    record_id		int

• Accounting - Account (konto)

  • List Methods
  • Expand Methods

  • GETGet/account/get
    Get account
    
    

    Parameter	Value	Type	Description
    account_id		int

  • GETList/account/list
    List accounts
    
    

    Parameter	Value	Type	Description
    query		string	Search query to limit results

  • POSTCreate/account/create
    Create account
    
    

    Parameter	Value	Type	Description
    number		int	Account number (not to be confused with account_id)
    name		string
    type	assetdebtincomeexpense	enumerated

  • POSTUpdate/account/update
    Update account
    
    

    Parameter	Value	Type	Description
    account_id		int
    number		int	Account number (not to be confused with account_id)
    name		string
    type	assetdebtincomeexpense	enumerated

  • POSTDelete/account/delete
    Delete account
    
    

    Parameter	Value	Type	Description
    account_id		int

• Accounting - AccountBalance (saldo)

  • List Methods
  • Expand Methods

  • GETList/accountbalance/list
    List account balances per date
    
    

    Parameter	Value	Type	Description
    start		date	Start of date range
    end		date	End of date range
    filter_only_first_and_last	10	boolean	Return only ingoing balance for start date and outgoing balance for end date
    filter_account_number		string	Only include account matching account number. Multiple numbers can be separated by comma (1910,1920,1930)

• Accounting - Ledger (huvudbok)

  • List Methods
  • Expand Methods

  • GETList/ledger/list
    List accounting transactions grouped by account and date
    
    

    Parameter	Value	Type	Description
    start		date	Start of date range
    end		date	End of date range
    filter_include_draft	10	boolean	Include transactions with record.locked = false (utkast)
    filter_account_number		string	Only include account matching account number. Multiple numbers can be separated by comma (1910,1920,1930)

• Accounting - Period (räkenskapsår)

  • List Methods
  • Expand Methods

  • GETList/period/list
    List periods
    
    
  • POSTCreate/period/create
    If periods exist, start must be the day after the last existing period's end
    
    

    Parameter	Value	Type	Description
    start		date	First day of the period, yyyy-mm-dd
    end		date	Last day of the period, yyyy-mm-dd

• Sorting - File (fil)

  • List Methods
  • Expand Methods

  • GETGet/file/get
    Get file object. Does not return file data, see /file/download
    
    

    Parameter	Value	Type	Description
    file_id		int

  • GETDownload/file/download
    Download file, returns file data only
    
    

    Parameter	Value	Type	Description
    file_id		int

  • GETList/file/list
    List files
    
    
  • POSTCreate/file/create
    Create file. A file is an object in Zenconomy with a name and description. Optionally you can include an actual file, for example an image or a PDF file, and attach it to the file object.
    
    

    Parameter	Value	Type	Description
    name		string	Name of file to be uploaded, including extension. Valid extensions are gif, jpg, jpeg, jpe, png, pdf, tiff, tif, html, htm, txt, text
    description		string	Textual description of the file
    data		string	BASE64-encoded string containing the file data. Maxmium file size is 4MB. If this parameter is omitted, a file object without attached data will be created.

  • POSTDelete/file/delete
    Delete file
    
    

    Parameter	Value	Type	Description
    file_id		int

• Global - Contact (kontakt/kund/leverantör)

  • List Methods
  • Expand Methods

  • GETGet/contact/get
    Get contact
    
    

    Parameter	Value	Type	Description
    contact_id		int

  • GETList/contact/list
    List contacts
    
    

    Parameter	Value	Type	Description
    query		string	Search query to limit results

  • POSTCreate/contact/create
    Create contact
    
    

    Parameter	Value	Type	Description
    name		string
    reference		string
    website		string
    email		string
    address1		string
    address2		string
    city		string
    state		string
    postalcode		string
    country		string
    taxcode		string

  • POSTUpdate/contact/update
    Update contact
    
    

    Parameter	Value	Type	Description
    contact_id		int
    name		string
    reference		string
    website		string
    email		string
    address1		string
    address2		string
    city		string
    state		string
    postalcode		string
    country		string
    taxcode		string

  • POSTDelete/contact/delete
    Delete a contact
    
    

    Parameter	Value	Type	Description
    contact_id		int	Contact ID

• Global - Transactionaccount (konto för in- och utbetalningar)

  • List Methods
  • Expand Methods

  • GETGet/transactionaccount/get
    Get transactionaccount
    
    

    Parameter	Value	Type	Description
    transactionaccount_id		int

  • GETList/transactionaccount/list
    List transactionaccounts
    
    
  • POSTCreate/transactionaccount/create
    Create transactionaccount
    
    

    Parameter	Value	Type	Description
    transactionaccount_id		int	ID for related accounting account
    name		string
    type	personalcashbanktaxother	enumerated

  • POSTUpdate/transactionaccount/update
    Update transactionaccount
    
    

    Parameter	Value	Type	Description
    transactionaccount_id		int
    account_id		int	ID for related accounting account
    name		string
    type	personalcashbanktaxother	enumerated

  • POSTDelete/transactionaccount/delete
    Delete transactionaccount
    
    

    Parameter	Value	Type	Description
    transactionaccount_id		int