Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

When set an existing address will be deleted. This switch is only used when addresses are passed-in nested inside their parent object(a contact).

Should contain the street or otherwise primary address information.

Additional address information, like floor number

Type of the address, as seen by vCard definition. There can only be one type. Inside of SK you can use placeholders like client.parcel_address.city to access the first parcel adr(Same for work_ / home_).
Besides the placeholder default_address, always returns the first address found. Sorting is done by the order(if set) else by date, newest first.

work, home, parcel

City for the address. Must at least be present for an address.

Country of the address.

Geo-Location latitude

Geo-Location longitude

Addresses are normally sorted by date, newest first. If you need to strongly rely on their sorting e.g. default_address (always first) or have multiple addresses of one type(3 parcel), use this field for all adrs.
Single adrs are used in placeholders like: addresses.2.city, returning the second adr found(not necessarily one with order=2).

Post office box number

Country state of address

Zip number of the city. Length must be between 4..10

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

When set an existing item will be deleted. This switch is used for items submitted nested within their parent object(a document), which is default as long as there is no line item endpoint available.

The divider text

Required since items are sorted by position.

The item type: DividerItem. Must be set when creating new items via document.items array

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Gross total of all line items, 2 decimals places in document currency.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, normally shown in envelope window. Defaults to client address_field.

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard. 3-letter UPCASE: EUR, USD

Date the document is issued. Automatically set when document is opened. Required for non-draft documents. YYYY-MM-DD

Some external reference, whatever this may be.

Items for the document. Access items of all types including divider and sub_total items.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Line items for the document

Line items

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique number assigned by a user or automatic by the object's number schema.

The specific type of the document singular CamelCased: Invoice, PaymentReminder

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your invoice [number]'

The exported data as attachment.

Attachment

Date the object was created in SK. Never changes afterwards

Date the was finished

Unique identifier - UUID

true

Errors and warnings, can contain html markup f.ex. links to contacts with invalid back accounts when doing dtaus export

Date the was started

The export status

pending, in_progress, failed, success

Date the object was edited in SK.

Comma separated uuid's of the export objects. The backend uses a mysql text-column limited to ~64kb. 100 uuids are ~2.5kb

The type of data to export. Lower-case singular name of the export data's class(invoice,contact..), see available classes in json schema. Not required for text-exports, getting the type from the export_template.

The export type. text: uses an export template defined by a template_id. archived_pdf: zip with archived PDF(documents only). allinone_pdf: All archived PDF(Documents) in one big PDF. attachments: All attachments of the given objects as zip. SEPA: bank exports, relies on valid bank information in your company, the exported document and the contact.

text, archived_pdf, attachments, allinone_pdf, sepa_debit, sepa_credit

A team uuid. If set only the team and its parent teams can see the record.

A export template uuid. Required for text exports. collection_type can be empty as is forced to the templates type

Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one.

Attachment

The contact for the document. Use contact_id field to set a contact.

Contact

Cost total of all line items, 2 decimals places in document currency.

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100

Total gross margin across all line items. Calculated from net_total-cost_total.

Gross total of all line items, 2 decimals places in document currency.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the order is issued. Automatically set when order is opened. Required for non-draft documents. YYYY-MM-DD

Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD

Used to calculate the due date for the document. Useless if date and due date are present.

Some external reference, whatever this may be.

Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins and increments version.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique number assigned by SK order number schema. Auto-assigned when order is opened. Required unless doc status is draft.

How the document is being payed. Used in new payments.

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

Defaults to draft for new documents, unless otherwise stated. For new documents with status 'open' or 'closed' or doc where the status changes away from draft, following fields are set if empty: number(next in number schema), date(today), due date(due_days must be given). Only draft documents can be deleted.

draft

draft, open, closed

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your order [number]'

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Name of the created export file. Date placeholders can be used: %y-%m-%d_%H-%M_clients.csv

Kind of object the template can be used for.

invoice, estimate, credit_note, payment_reminder, order, contact, payment, comment, email, history, product, recurring

A meaningful name.

A team uuid. If set only the team and its parent teams can see the record.

Text with placeholders, replaced when the template is used.

Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one.

Attachment

The contact for the document. Use contact_id field to set a contact.

Contact

Cost total of all line items, 2 decimals places in document currency.

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100

Total gross margin across all line items. Calculated from net_total-cost_total.

Gross total of all line items, 2 decimals places in document currency.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Recurring document ID, if the invoice was created from a recurring.

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the invoice is issued. Automatically set when invoice is opened. Required for non-draft documents. YYYY-MM-DD

Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD

Used to calculate the due date of the document. Useless if date and due date are present.

Some external reference, whatever this may be.

Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins and increments version.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique number assigned by SK invoice number schema. Auto-assigned when invoice is opened. Required unless doc status is draft.

How the document is being payed. Used in new payments.

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

SEPA direct debit sequence type. Check with you bank how they handle FRST(first) and FNAL(final) types. When exporting SEPA debit to your bank the type defaults to OOF if blank.

FRST, OOFF, RCUR, FNAL

SEPA mandate identifier needed in direct debit transactions. This is a unique id given by you to the customer beforehand.

Date the SEPA mandate was signed by your customer. Must not be in the future!

Defaults to draft for new documents, unless otherwise stated. For new documents with status 'open' or 'closed' or doc where the status changes away from draft, following fields are set if empty: number(next in number schema), date(today), due date(due_days must be given). Only draft documents can be deleted. Beware that the overdue-status is virtual as it depends on the real status=open and the document date.

draft

draft, open, closed, overdue

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your invoice [number]'

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

A team uuid taken from the related object. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

uuid of the comments parent object.

Object type of the comments parent. Is the camelcased base class name: Document for invoice, credit_note, contact

The comment himself.

Link to a company's SalesKing account.

Date the record was created in SK. Never changes afterwards.

Unique identifier - UUID

true

Last date when the record was edited.

A company can have many addresses, sorted by date descending(new first). Default address used in placeholder is the most recent one.

Addresses

Bank account number.

IBAN Number of the bank account. Is validated

Bank name

Bank number

Bank account owner

SWIFT BIC- Bank Identifier Code

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Email address

Default language, used for new users. Must be a valid language available in SalesKing

Company name

Fax number

Mobile phone number

Office phone number

SEPA Creditor ID, needed for SEPA direct debit transactions.

Unique subdomain identifying the company's SalesKing account.

Tax number, normally applies to a private person running a small business.

Default time zone, used for new users

A company website

VAT number, for a company entitled to pay value added taxes.

The exchanged amount.

Date the object was created in SK. Never changes afterwards

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Unique identifier - UUID

true

A team uuid taken from the related object(e.g.invoice). If set only the team and its parent teams can see the record.

The payment amount

The cash discount amount. If a client withdraws a cash discount say 2% of 100€, he pays 98€ used in amount and 2€ in cash_discount. Handled separate for correction of sales,vat accounts in bookkeeping.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the payment was made. YYYY-MM-DD

Reference number f.ex. issued by the bank.

If set the related document is NOT closed.

false

Add a late fee if an invoice has payment reminders. We create a second payment for the last reminder and close all others. Set to 0, if you want to waive the fee(has not been paid). In this case all reminders are closed and we also correct the sales+debtor account with the open fees. This is a pure setter-method used in creation!

How the payment was made.

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

uuid of the payments parent object. Is auto-set when using the nested URL POST invoices/ID/payments

Object type of the payments parent. Is the camel-cased base class name: Document for invoice, credit_note. Is auto-set when using the nested URL POST invoices/ID/payments

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Language short-code

The name of the language, shown in the interface

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Additional information about the template.

Kind of object the template can be used for.

invoice, estimate, credit_note, payment_reminder, order

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. A multi-language template should belong to a parent. From then on just choose the parent-template and the localized child version is used for printing if the related object(order, invoice,..) has the appropriate language.

Name of the template as shown to the user.

A team uuid. If set only the team and its parent teams can see the record.

The contact for the document. Use contact_id field to set a contact.

Contact

Cost total of all line items, 2 decimals places in document currency.

Date the object was created in SK. Never changes afterwards.

Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100

Total gross margin across all line items. Calculated from net_total-cost_total.

Gross total of all line items, 2 decimals places

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id given.

Enable automatic sending of new invoices created from the recurring. Opens the invoice, creates a PDF and sends an email to the contact. GOTCHA's: check PDF-, Email-Template, SMTP Settings and of course the contacts email address! Since new recurrings which start today directly create new invoices, they are also SEND if auto_send is true!! If something fails, we'll send an error-email to the user who created the recurring. For success infos you can add yourself to the BCC of the email template or

email

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

First date the recurring is issued. Not allowed to be in the past. YYYY-MM-DD

Used to calculate the due date of the recurring. Useless if date and due date are present.

The Email template used for the email in auto sending. Required when auto_send'ing is enabled.

Some external reference, whatever this may be.

The last date the recurring is executed. YYYY-MM-DD

Recurring frequency

yearly, monthly, weekly, quarterly, biweekly, sixmonthly

Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins and increments version.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique name to identify the document. Unlike all other document this one has no number schema and not auto assign

How the document is being payed. Used in new payments.

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

The PDF template used for printing the invoice when auto sending. Required when auto_send'ing is enabled.

SEPA direct debit sequence type. Check with you bank how they handle FRST(first) and FNAL(final) types. When exporting SEPA debit to your bank the type defaults to OOF if blank.

FRST, OOFF, RCUR, FNAL

SEPA mandate identifier needed in direct debit transactions. This is a unique id given by you to the customer beforehand.

Date the SEPA mandate was signed by your customer. Must not be in the future!

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your recurring [number]'

Returns the address field used on new docs. Consist of Organisation name and default(first) address

Date the record was created in SK. Never changes afterwards.

Unique identifier - UUID

true

Last date when the record was edited.

A client can have many addresses, sorted by date descending(new first). Default address is the most recent one.

Address

Bank account number.

IBAN Number of the bank account. Is validated

Bank name

Bank number

Bank account owner

SWIFT BIC- Bank Identifier Code

The birthday. YYYY-MM-DD

Default cash discount for new invoices.

Date the contact converted from lead to client or any other contact type (supplier)

Currency code as defined by the ISO 4217 standard(3-letter UPCASE: EUR, USD). If set the currency is taken for new documents.

Default due days for new invoices.

Email address of the contact.

First name of a person.

Can be empty for a company. Is used in salutation

male, female

An employee gets number, organisation, tax and vat_number from its parent. If you set any of these, they are overwritten. When changing a parent-contact the fields on his direct child-employees are updated too.

false

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the client is emailed, a localized version of a multi-language template(email, pdf) will be used if available. The language will also be set for new documents.

Last name of a person. At least this or the organisation field must be filled for new records

Lead date e.g. date of first contact with your company. YYYY-MM-DD

Lead reference e.g. a tracking id, web-url

Lead source describing where a contact came from e.g. a campaign name, website, facebook, URL

Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.

Notes for a contact. For day to day information you should use comments instead.

Unique number, auto-created by SK for new contacts(client, supplier) without number.

Name of a company. This or lastname must be present

ID of a parent contact.

Default payment method for used for new documemts

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

Fax number

Private phone number

Mobile phone number

Office phone number

Position of a person in a company.

Space separated list of tags. Are split and saved as Tag objects on create, update.

Tax number, normally applies to a private person

A team uuid. If set only the team and its parent teams can see the record. The team is set for all new documents and related objects like comments, attachments, emails. When changed ALL related objects are updated with the new team!!

Academical title of a person e.g. Dr., Prof

Type of contact

Client, Lead, Supplier

An url associated with the person, e.g its company website.

VAT number, for a company or person paying value added taxes.

Unique identifier - UUID

true

The tag itself

Usage count of this tag, for all objects in whole company scope.

Returns the address field used on new docs. Consist of Organisation name and default(first) address

Date the record was created in SK. Never changes afterwards.

Unique identifier - UUID

true

Last date when the record was edited.

A client can have many addresses, sorted by date descending(new first). Default address is the most recent one.

Address

Bank account number.

IBAN Number of the bank account. Is validated

Bank name

Bank number

Bank account owner

SWIFT BIC- Bank Identifier Code

The birthday. YYYY-MM-DD

Default cash discount for new invoices.

Currency code as defined by the ISO 4217 standard(3-letter UPCASE: EUR, USD). If set the currency is taken for new documents.

Default due days for new invoices.

Email address of the contact.

First name of a person.

Can be empty for a company. Is used in salutation

male, female

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the client is emailed, a localized version of a multi-language template(email, pdf) will be used if available. The language will also be set for new documents.

Last name of a person. At least this or the organisation field must be filled for new records

Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.

Notes for a contact. For day to day information you should use comments instead.

Unique number, auto-created by SK for new client without number.

Name of a company. This or lastname must be present

Default payment method for used for new documemts

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

Fax number

Private phone number

Mobile phone number

Office phone number

Position of a person in a company.

Space separated list of tags. Are split and saved as Tag objects on create, update.

Tax number, normally applies to a private person

A team uuid. If set only the team and its parent teams can see the record.

Academical title of a person e.g. Dr., Prof

An url associated with the person, e.g its company website.

VAT number, for a company or person paying value added taxes.

Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one.

Attachment

The contact for the document. Use contact_id field to set a contact.

Contact

Cost total of all line items, 2 decimals places in document currency.

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100

Total gross margin across all line items. Calculated from net_total-cost_total.

Gross total of all line items, 2 decimals places in document currency.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Address field with the receiver. Shown in envelope window.

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the credit note is issued. Automatically set when document is opened. Required unless doc status is draft. YYYY-MM-DD

Auto-calculated from date + due days if empty and the document is opened. YYYY-MM-DD

Used to calculate the due date of the credit note. Useless if date and due date are present.

Some external reference, whatever this may be.

Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique number assigned by SK credit note number schema. Auto-assigned when document is opened. Required unless doc status is draft.

How the document is being payed. Used for new payments.

cash, bank_transfer, credit_card, paypal, direct_debit, cheque, moneybookers, premium_sms

Defaults to draft for new documents, unless otherwise stated. For new documents with status 'open' or 'closed' or doc where the status changes away from draft, following fields are set if empty: number(next in number schema), date(today), due date(due_days must be given). Only draft documents can be deleted.

draft

draft, open, closed

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your credit note [number]'

Date the record was created in SK. Never changes afterwards.

Unique identifier - UUID

true

Last date when the record was edited.

An url receiving the notification. The url MUST be within the url of the current app and receives a POST with a single signed_request parameter containing an base64 encoded JSON object.

The channel to which to subscribe. See available at subs/channels.

Auto detected on upload. Might not always reflect the real content type

Date the object was created in SK. Never changes afterwards

Unique filename set by SK

The filename as set when uploaded

uuid of the object.

true

Filesize in kb. Auto detected on upload.

True if the file(pdf) has been digitally signed.

uuid of the attachment parent object.

Object type of the attachment parent. A base class name: Document(for invoice, credit_note) Contact, Message(for email), Template(for email, pdf template)

A team uuid. If set only the team and its parent teams can see the record.

Total costs. Calculated from cost_single * quantity

Date the object was created in SK. Never changes afterwards

Gross margin percentage. Calculated from gross_margin_total/cost_total

Gross margin, the difference between revenue and cost before accounting for certain other costs. Calculated from net_total - cost_total

Gross price. Net total with taxes applied.

Unique identifier - UUID

true

Net price of a single item. Calculated from price_single * quantity * discount

Date the object was edited in SK.

When set an existing item will be deleted. This switch is used for items passed-in nested inside their parent object(a document), which is default as long as there is no line item endpoint available.

Cost price for a single item. Used to calculate the gross margin

Item description

Discount in percent applied to the items net total. Can also be negative if you want to add additional charges.

Arbitrary number e.g. external product reference.

The name of an item

Position by which the items are sorted. Two items can have the same position(if you dont care) and numbers dont need to continuous

1

Net price of a single item. If a product id is given, price_single is taken from the product if not set.

A uuid of a product, used by this item. If set or changed, the product fields (name, description, quantity, unit, price, cost price) are copied if the according item fields are missing/blank. Besides this product link makes it possible to track a products turnover and find the documents it is used on.

Quantity of the item. Must be >= 0

1

Quantity unit: kg, days, month.

Tax percent for a single item.

The item type: LineItem. Must be set when creating new items via document.items array

Date the object was created in SK. Never changes afterwards

Gross sub-total

Unique identifier - UUID

true

Net sub-total

Date the object was edited in SK.

When set an existing item will be deleted. This switch is used for items passed-in nested inside their parent object(a document), which is default as long as there is no line item endpoint available.

Title of the sub-total e.g. Hardware total

Required since items are sorted by position.

The item type: SubTotalItem. Must be set when creating new items via document.items array

The context for the permission, being a resource: clients, emails

Unique identifier - UUID

true

A permission has many privileges which define the actions someone can execute. Such actions are resource methods like index, update, edit, show

Context_name and name localized: API Clients read - API Kunden anzeigen

Name for the permission. Since a permission groups multiple privileges the name reflects what someone is allowed to do: read, update, delete. With 'read' granting acccess to the 'index' and 'show' actions of a resource.

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Default blind copy receivers comma separated valid email addresses.

Body with placeholders, replaced when the template is used.

Default copy receivers comma separated valid email addresses.

Default from address. A valid email address. Make sure your server(if custom SMPT settings for the API user) allows sending with this address.

Kind of object the template can be used for.

invoice, estimate, credit_note, payment_reminder, order, contact

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. A multi-language template must belong to a parent. From then on just choose the parent-template and the localized child version is used if the related object(client, invoice,..) of the email, has the appropriate language.

A meaningful name.

Subject containing placeholders, replaced when the template is used.

A team uuid. If set only the team and its parent teams can see the record.

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Kind of object the template can be used for. If empty the snippet can be used global. In this case watch not all placeholders are available: a client has different fields than an invoice.

, invoice, estimate, credit_note, payment_reminder, order, contact, email

A meaningful name.

A team uuid. If set only the team and its parent teams can see the record.

Text which may contain placeholders, replaced when the template is used.

Date the record was created in SK. Never changes afterwards.

Unique identifier - UUID

true

Last date when the record was edited.

Email address of the user. Unique in SK

First name

The users gender, used in salutation

male, female

The users language, reflected in the interface.

Last name of a person. At least this or the organisation field must be filled for new records

Fax number

Private phone number.

Mobile phone number

Office phone number

Position of a person in a company.

Time zone

Academical title of a person e.g. Dr., Prof

An url associated with the person, e.g its company website.

Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one.

Attachment

The contact for the document. Use contact_id field to set a contact.

Contact

Cost total of all line items, 2 decimals places in document currency.

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Percentage of gross profit to cost of items sold. Calculated from gross_margin_total/net_total*100

Total gross margin across all line items. Calculated from net_total-cost_total.

Gross total of all line items, 2 decimals places in document currency.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

Net total, 6 decimal places incl. discount

Tax total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.

The contact uuid. When assigning a contact its language, currency, address_field (due days, cash discount) values are used for the document if those doc-fields are not set.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the estimate is issued. Automatically set when estimate is opened. Required for non-draft documents. YYYY-MM-DD

Auto-calculated from date + due days if empty and the estimate is opened. YYYY-MM-DD

Used to calculate the valid-until date of the estimate. Useless if date and due date are present.

Some external reference, whatever this may be.

Items for the document. Access items of all types including divider and sub_total items. GOTCHAs when using items instead of line_items: You MUST set the type field(CamelCasesItem class name) on each item. You cannot use both, the line_items array is stronger for backward compat.

any

Line item Divider item Sub total item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins and increments version.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.

Unique number assigned by SK estimate number schema. Auto-assigned when estimate is opened. Required unless doc status is draft.

Defaults to draft for new documents, unless otherwise stated. For new documents with status 'open' or 'closed' or doc where the status changes away from draft, following fields are set if empty: number(next in number schema), date(today), due date(due_days must be given). Only draft documents can be deleted.

draft

draft, open, closed, rejected, billed

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your estimate [number]'

Date the object was created in SK. Never changes afterwards

Unique identifier - UUID

true

Date the object was edited in SK.

Name of the product category. A new category is created if it does not exist.

Cost price of a single product

Product description

Increased on every edit, so SK can detect/prevent a concurrent edit by another user. First save wins.

The name of the product

Unique number assigned by you or if empty SK product number schema.

Net price of a single product

Unit like kg, days, month.

Space separated list of tags. Are split and saved as Tag objects on create, update.

Tax percentage for this product.

A team uuid. If set only the team and its parent teams can see the record.

Archived PDF version of the document. Is created when an document is printed and archived. A document can have multiple archived versions. This only returns the most recent one.

Attachment

The contact for the document. Is assigned through the related invoice.

Contact

The contact uuid. Is assigned through the related invoice.

Date the object was created in SK. Never changes afterwards.

The exchange rate from the foreign document currency(eg. USD) to the company currency(EUR). If the rate is empty we use the exchange rate on the document date or today if doc.date is empty. If there is no rate for this day, say on weekends, the closest previous day is taken(Sunday->Friday). If you open the doc at a later time make sure to manually refresh the rate, as we dont change it.

Exchanged gross total, in your company currency.

Unique identifier - UUID

true

Net total, 2 decimals places

A team uuid taken from the contact. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

Receiver address, shown in envelope window. Defaults to invoice.client.address_field if created from invoice.

Currency code as defined by the ISO 4217 standard (3-letter UPCASE: EUR, USD)

Date the payment_reminder is issued. Automatically set when created from invoice. Defaults to today. YYYY-MM-DD

Auto-calculated from date + due days if empty and the payment_reminder is opened. YYYY-MM-DD

Used to calculate the due date of the payment_reminder. Useless if date and due date are present. Taken from settings when created from invoice

Some external reference, whatever this may be.

The invoice for the reminder. If set assumes all other fields are set to custom values, instead of filling them from the invoice. POSTing to invoices/:id/payment_reminders, automatically set this and all other fields.

Items for the document. GOTCHAs: you should NOT create items manually since we create them. The first item contains the invoice total and the optional second one the late_fee.

any

Line item

Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.

Auto-incremented to prevent concurrent updates. First save wins and increments version.

Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used. Defaults to values from settings

Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used. Defaults to values from settings

Defaults to open for new reminders, unless otherwise stated. Beware that the overdue-status is virtual as it depends on the real status=open and the document due_date.

open

draft, open, closed, overdue

Space separated list of tags. Are split and saved as Tag objects on create, update.

The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your payment_reminder [number]'. Defaults to values from settings

The emails attachments.

Attachment

Date the object was created in SK. Never changes afterwards

Date the email was delivered by SK. If set, the message cannot be edited anymore.

Unique identifier - UUID

true

Is set after an email has been scheduled for sending until it has been sent.

Logs error message when sending failed.

A team uuid taken from the related object. If set only the team and its parent teams can see the record.

Date the object was edited in SK.

BCC addresses, comma separated. Max 5, format: a@b.de,'George'

The email text.

CC addresses, comma separated. Max 5, format: a@b.de,'George'

From address. If empty the email of the current user is taken.

uuid of the emails parent object.

Object type of the emails parent. Is the camelcased base class name: Document for invoice, credit_note, contact,..

The email subject.

TO addresses, comma separated. Max 5, format: a@b.de,'George'