Skip to content

Accounting

Accounting can be used to send account level information (receipts) about operational income and costs of running the company.

This information is used to eg. to calculate various margins usually found in profit loss statements.

Operations

Upload accounting data

Request

POST https://api.zoined.com/accounting?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
transaction_idstringrequired

Unique ID for this accounting receipt

Example:"1234"
line_item_idstringrequired

Unique ID for this accounting receipt line item

Example:"1"
organisation_idstringrequired

Organisation/Store ID

Example:"540"
department_idstring

Store department ID

Example:"5401"
account_idstringrequired

Account ID

Example:"1150"
event_datestringrequired

Event date (yyyy-mm-dd)

Example:"2016-01-01"
event_timestring

Event time (HH:mm:ss)

Example:"15:00:00"
receipt_typestringrequired

Receipt type

Enum ValueDescription
income

This receipt is income for the company in income statement

cost

This receipt is cost for the company in income statement

asset

This receipt is balance sheet asset (eg. property) for the company

liability

This receipt is balance sheet liability (eg. debt) for the company

Example:"cost"
receipt_numberstring

XZY (string, optional) - Optional bookkeeping receipt number

Example:"12345"
receipt_valuenumber

Total amount of this line item

Example:2000
receipt_value_wo_vatnumber

Total amount of this line item without taxes

Example:1600
currencystring

Currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
cancelledboolean

If set then this receipt has been cancelled.

Example:true
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/accounting?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transaction_id": "1234",
    "line_item_id": "1",
    "organisation_id": "540",
    "department_id": "5401",
    "account_id": "1150",
    "event_date": "2016-01-01",
    "event_time": "15:00:00",
    "receipt_type": "cost",
    "receipt_number": "12345",
    "receipt_value": 2000,
    "receipt_value_wo_vat": 1600,
    "currency": "EUR",
    "cancelled": true,
    "custom_field_1": "XYZ",
    "custom_field_2": "XYZ",
    "custom_field_3": "XYZ",
    "custom_field_4": "XYZ",
    "custom_field_5": "XYZ",
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}