Control Edge API

Version 3.6

Using the Control Edge API, you can easily create integrations between Control Edge, IM and other accounting applications and BI systems. The Control Edge API allows integrators to create, read, and update various data from Control Edge and IM, including accounts, fixed assets, invoices, vouchers, and more.

Notifications

See separate documentation on Visma Community for how to activate notifications via the Developer Portal.

Type	Comment
Articles	Notifications when changes are done to the register in Control.
Customer	Notifications when changes are done to the register in Control.
Supplier	Notifications when changes are done to the register in Control.
Account	Notifications when changes are done to the register in Control.

Authentication

Signup for api access on https://oauth.developers.visma.com/. Details

(https://docs.connect.visma.com/v1/docs/developer-portal)

Obtain an Api access token using the clientId and clientSecret generated at the

previous step. https://oauth.developers.visma.com/service-registry/documentation/authentication POST /connect/token HTTP/1.1 Host: connect.visma.com Content-Type: application/x-www-form-urlencoded Content-Length: 187 client_id=ApplicationId - created on developers.visma.com client_secret=yyyyyyyyyyyyyyyyyy grant_type=client_credentials tenant_id=xxxxxxxxxxxxx

Find the desired endpoint. https://controlapi.control.visma.com/swagger/index.html
Make the call to the endpoint passing the obtained access token. The token must be sent

in the HTTP header of every subsequent call and it has a validity of one hour. After one hour a new token must be requested. GET /api/account/get-accounts HTTP/1.1 Host: controlapi.control.visma.com StorageSpaceId: xxxxxxxxxxxxxxx Authorization: Bearer 9

Swaggerpage

Staging URL https://stage-controlapi.control.visma.com/swagger Production URL https://controlapi.control.visma.com/swagger 10

Control Edge endpoints

This section describes endpoints for Control Edge. 11

Account

Get method : /api/account/get-accounts

This method will return a list of the accounts

Field	Datatype	Size	Comment
name	String	30	Accountname
accountNumber	String	6	Accountnumber
accClass	String	1	Accountclass
accType	Int		Accounttype. 1=Acquiring account, 2=Debt account, 3=Revenue account, 4=Expense account
standard	Byte		Account function
userGroup1	String	64	From usergroups of type ACCOUNT1
userGroup2	String	64	From usergroups of type ACCOUNT2
userGroup3	String	64	From usergroups of type ACCOUNT3
userGroup4	String	64	From usergroups of type ACCOUNT4
userGroup5	String	64	From usergroups of type ACCOUNT5
userGroup6	String	64	From usergroups of type ACCOUNT6
userGroup7	String	64	From usergroups of type ACCOUNT7
userGroup8	String	64	From usergroups of type ACCOUNT8
userGroup9	String	64	From usergroups of type ACCOUNT9
userGroup10	String	64	From usergroups of type ACCOUNT10
userGroup11	String	64	From usergroups of type ACCOUNT11
userGroup12	String	64	From usergroups of type ACCOUNT12
userGroup13	String	64	From usergroups of type ACCOUNT13
userGroup14	String	64	From usergroups of type ACCOUNT14
userGroup15	String	64	From usergroups of type ACCOUNT15
userGroup16	String	64	From usergroups of type ACCOUNT16
userGroup17	String	64	From usergroups of type ACCOUNT17
userGroup18	String	64	From usergroups of type ACCOUNT18
userGroup19	String	64	From usergroups of type ACCOUNT19
userGroup20	String	64	From usergroups of type ACCOUNT20
vatCode	Byte		Vatcode that is used for account
accGroup	String	2	Accountgroup
useCurrency	Byte		0=Never use currency, 1=Can use currency, 2=Must use currency
currency	String	3	Currency used for account
replaceAcc	String	6	Account that is used if account is disabled
sign	Byte		0=Can use both -/+, 1=debet, 2=kredit
created	Datetime		When the account was created
disabledDate	Datetime		When the account was disabled
o1	Int		0=Never use object type 1, 1=Can use object type 1, 2=Must use object type 1
o2	Int		0=Never use object type 2, 1=Can use object type 2, 2=Must use object type 2
o3	Int		0=Never use object type 3, 1=Can use object type 3, 2=Must use object type 3
o4	Int		0=Never use object type 4, 1=Can use object type 4, 2=Must use object type 4
o5	Int		0=Never use object type 5, 1=Can use object type 5, 2=Must use object type 5
o6	Int		0=Never use object type 6, 1=Can use object type 6, 2=Must use object type 6
o7	Int		0=Never use object type 7, 1=Can use object type 7, 2=Must use object type 7
o8	Int		0=Never use object type 8, 1=Can use object type 8, 2=Must use object type 8
useO1	String	64	Use this object of type 1
useO2	String	64	Use this object of type 2
useO3	String	64	Use this object of type 3
useO4	String	64	Use this object of type 4
useO5	String	64	Use this object of type 5
useO6	String	64	Use this object of type 6
useO7	String	64	Use this object of type 7
useO8	String	64	Use this object of type 8
useNum	Byte		0=Never use quantity, 1=Can use quantity, 2=Always use quantity
prop	Int		Bit field. 1)
uac	int		User Access Code

Value	Comment
0	If account is used for assets
1	If account is used for supplierledgers
2	If account is used for customerledgers
3	If account is used for manual bookings
4	If account is used for budget
5	If account is used for currencyevaluation

Get method : /api/account/get-by-id

This method will return one account

Inputfield	Datatype	S	ize	Comment
accountnumber	String	6		Account number

Field	Datatype	Size	Comment
name	String	30	Accountname
accountNumber	String	6	Accountnumber
accClass	String	1	Accountclass
accType	Int		Accounttype. 1=Acquiring account, 2=Debt account, 3=Revenue account, 4=Expense account
standard	Byte		Account function
userGroup1	String	64	From usergroups of type ACCOUNT1
userGroup2	String	64	From usergroups of type ACCOUNT2
userGroup3	String	64	From usergroups of type ACCOUNT3
userGroup4	String	64	From usergroups of type ACCOUNT4
userGroup5	String	64	From usergroups of type ACCOUNT5
userGroup6	String	64	From usergroups of type ACCOUNT6
userGroup7	String	64	From usergroups of type ACCOUNT7
userGroup8	String	64	From usergroups of type ACCOUNT8
userGroup9	String	64	From usergroups of type ACCOUNT9
userGroup10	String	64	From usergroups of type ACCOUNT10
userGroup11	String	64	From usergroups of type ACCOUNT11
userGroup12	String	64	From usergroups of type ACCOUNT12
userGroup13	String	64	From usergroups of type ACCOUNT13
userGroup14	String	64	From usergroups of type ACCOUNT14
userGroup15	String	64	From usergroups of type ACCOUNT15
userGroup16	String	64	From usergroups of type ACCOUNT16
userGroup17	String	64	From usergroups of type ACCOUNT17
userGroup18	String	64	From usergroups of type ACCOUNT18
userGroup19	String	64	From usergroups of type ACCOUNT19
userGroup20	String	64	From usergroups of type ACCOUNT20
vatCode	Byte		Vatcode that is used for account
accGroup	String	2	Accountgroup
useCurrency	Byte		0=Never use currency, 1=Can use currency, 2=Must use currency
currency	String	3	Currency used for account
replaceAcc	String	6	Account that is used if account is disabled
sign	Byte		0=Can use both -/+, 1=debet, 2=kredit
created	Datetime		When the account was created
disabledDate	Datetime		When the account was disabled
o1	Int		0=Never use object type 1, 1=Can use object type 1, 2=Must use object type 1
o2	Int		0=Never use object type 2, 1=Can use object type 2, 2=Must use object type 2
o3	Int		0=Never use object type 3, 1=Can use object type 3, 2=Must use object type 3
o4	Int		0=Never use object type 4, 1=Can use object type 4, 2=Must use object type 4
o5	Int		0=Never use object type 5, 1=Can use object type 5, 2=Must use object type 5
o6	Int		0=Never use object type 6, 1=Can use object type 6, 2=Must use object type 6
o7	Int		0=Never use object type 7, 1=Can use object type 7, 2=Must use object type 7
o8	Int		0=Never use object type 8, 1=Can use object type 8, 2=Must use object type 8
useO1	String	64	Use this object of type 1
useO2	String	64	Use this object of type 2
useO3	String	64	Use this object of type 3
useO4	String	64	Use this object of type 4
useO5	String	64	Use this object of type 5
useO6	String	64	Use this object of type 6
useO7	String	64	Use this object of type 7
useO8	String	64	Use this object of type 8
useNum	Byte		0=Never use quantity, 1=Can use quantity, 2=Always use quantity
prop	Int		Bit field. 1)
uac	int		User Access Code

Value	Comment
0	If account is used for assets
1	If account is used for supplierledgers
2	If account is used for customerledgers
3	If account is used for manual bookings
4	If account is used for budget
5	If account is used for currencyevaluation

Post method : /api/account/createorupdate

This method will create or update an account

Inputfield	Datatype	Size	Comment
name	String	30	Accountname
accountNumber	String	6	Accountnumber
accClass	String	1	Accountclass
accType	Int		Accounttype. 1=Acquiring account, 2=Debt account, 3=Revenue account, 4=Expense account
userGroup1	String	64	From usergroups of type ACCOUNT1
userGroup2	String	64	From usergroups of type ACCOUNT2
userGroup3	String	64	From usergroups of type ACCOUNT3
userGroup4	String	64	From usergroups of type ACCOUNT4
userGroup5	String	64	From usergroups of type ACCOUNT5
userGroup6	String	64	From usergroups of type ACCOUNT6
userGroup7	String	64	From usergroups of type ACCOUNT7
userGroup8	String	64	From usergroups of type ACCOUNT8
userGroup9	String	64	From usergroups of type ACCOUNT9
userGroup10	String	64	From usergroups of type ACCOUNT10
accGroup	String	2	Accountgroup
currency	String	3	Currency used for account
replaceAcc	String	6	Account that is used if account is disabled
created	Datetime		When the account was created
disabledDate	Datetime		When the account was disabled
o1	Int		0=Never use object type 1, 1=Can use object type 1, 2=Must use object type 1
o2	Int		0=Never use object type 2, 1=Can use object type 2, 2=Must use object type 2
o3	Int		0=Never use object type 3, 1=Can use object type 3, 2=Must use object type 3
o4	Int		0=Never use object type 4, 1=Can use object type 4, 2=Must use object type 4
o5	Int		0=Never use object type 5, 1=Can use object type 5, 2=Must use object type 5
o6	Int		0=Never use object type 6, 1= Can use object type 6, 2=Must use object type 6
o7	Int		0=Never use object type 7, 1=Can use object type 7, 2=Must use object type 7
o8	Int		0=Never use object type 8, 1=Can use object type 8, 2=Must use object type 8
useO1	String	64	Use this object of type 1
useO2	String	64	Use this object of type 2
useO3	String	64	Use this object of type 3
useO4	String	64	Use this object of type 4
useO5	String	64	Use this object of type 5
useO6	String	64	Use this object of type 6
useO7	String	64	Use this object of type 7
useO8	String	64	Use this object of type 8

Note

If fields are not filed, then the value will be overwritten with blank value

Field	Datatype	Comment
	Bool	True / False

Get method : /api/account/vat/get-vats

This method will return all the vat codes

Field	Datatype	Size	Comment
vatcode	Byte		Vatcode. Id used in Visma Control
vatname	String	255	Description
vataccount	String	6	Account. Must exist in account register
vattransfer	String	6	Clearing account. Must exist in account register
vatpercent1	Numeric	28,8	Vat before vatswap
vatpercent2	Numeric	28,8	Vat after vatswap
vatswap	Datetime		Date when vat is changed
group1	String	64	From usergroups of type VAT1
group2	String	64	From usergroups of type VAT2
group3	String	64	From usergroups of type VAT3
group4	String	64	From usergroups of type VAT4
langtext	String	8	Language id for translation. Refers to languagetext.id

Agreement

Post method : /api/agreement

This method will create an agreement

Inputfield	Datatype	Size	Comment
cid	String	8	Business unit ID
custid	String	12	Customer ID to whom the invoice on account applies. Refers to customer.custid
account	String	6	Account receivable. Refers to account.account
id	String	8	ID of the invoice on account. Defined as a group of group type “INVSCR”
xtop	String	8	Terms of payment. Refers to xtop.id
fee	Decimal	28,8	Invoice fee
freight	Decimal	28,8	Freight
extrafee	Decimal	28,8	Administration fee
advance	Byte		1)
interval	Byte		Invoicing period, months
difference	Decimal	28,8	Difference
fixedexchange	Decimal	28,8	2)
subtype	Byte		3)
isforamount	Byte		4)
periodicmonths	Short		Number of periods for periodic allocation of the invoice row
startmonth	Short		Relative start month for performing periodic allocations
indexno	Int		Sequential number. Incremented for each repetitive use of the same id-custid pair
payer	String	12	Payer. Refers to customer.custid
payee	String	12	Payee. Refers to customer.custid
receiver	String	12	Receiver. Refers to customer.custid
startdate	Datetime		Start date of the invoice on account
blocked	Byte		5)
cashdiscount	String	40	Cash discount. Refers to cashdiscount.id
interest	String	40	Interest procedure. Refers to relinterest.id
yourorderno	String	40	Their order number
ourorderno	String	40	Our order number
yourreference	String	40	Their reference
yourreferencenumber	String	40	Reference number
ourreference	String	40	Our reference
enddate	Datetime		End date of the invoice on account
Lastdone	Datetime		Most recent invoicing date
firstinvdate	Datetime		First date when the invoicing can be performed
doneto	Datetime		Used only internally. Specifies until which date the auto-invoicing has been
			performed
currency	String	3	Currency for invoicing. Refers to currency.currency
xfreetext	String	255	Free text for invoice header
name	String	30	Name of the invoice on account
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
mod	String	8	Method of delivery of group type “MOD”
tod	String	8	Terms of delivery of group type “TOD”
extraid	String	30	Extra ID
bankcode	String	8	National bank code of group type “BANKCODE”
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type “LEDGER1”

group2	String	64	Free group of type “LEDGER2”
language	String	8	Language code of group type “LANGID”
tradecode	Byte		Commercial code
mop	String	8	Mode of payment. Refers to mop.id
invoicingperiodstart	Datetime		Invoicing period start
invoicingperiodend	Datetime		Invoicing period end
vattype	Int		6)
rows
account	String	6	Sale account
article	String	20	Provided article
type	Byte		7)
vatcode	byte		VAT code
number	Decimal	28,8	Number
amount	Decimal	28,8	Amount for each invoicing
firstamount	Decimal	28,8	First amount
lastamount	Decimal	28,8	Last amount
o1	String	64	Object of object type 1
o2	String	64	Object of object type 2
o3	String	64	Object of object type 3
o4	String	64	Object of object type 4
o5	String	64	Object of object type 5
o6	String	64	Object of object type 6
o7	String	64	Object of object type 7
o8	String	64	Object of object type 8
group1	String	64	Free group of type “VOUROW1”
group2	String	64	Free group of type “VOUROW2”
group3	String	64	Free group of type “VOUROW3”
group4	String	64	Free group of type “VOUROW4”
xfreetext	String	80	Free text for row
unit	String	8	Unit

Value	Comment
0	invoicing is performed afterwards
1	invoicing is performed in advance

Value	Comment
0	if fixed exchange rate is not to be used for payment
1	if fixed exchange rate is to be used for payment

Value	Comment
0	for ordinary invoice
1	for candidate for summary invoice

Value	Comment
0	all amounts are in domestic currency
1	all amounts are in foreign currency

Value	Comment
0	not blocked
1	blocked (no invoices will be created)

Value	Comment
0
1	Standard
2	Vat free
3	Reverse charge

Value	Comment
0	ordinary row
1	total row, partial sum
2	total row
3	blank row

Field	Datatype	Size	Comment
id	String
success	Bool
errors	List of Strings
validationErrors	List of Strings
additionalProp1
additionalProp2
additionalProp3
data	String

Get method : /api/agreement/{id}/{indexno}/{custid}

This method will get an agreement with rows based on id, index number and customer id

Inputfield	Datatype	Size	Comment
id	String	8	ID of the invoice on account. Defined as a group of group type “INVSCR”
indexno	Int	6	Account receivable. Refers to account.account
custid	String	12	Customer ID to whom the invoice on account applies. Refers to customer.custid

Field	Datatype	Size	Comment
cid	String	8	Business unit ID
custid	String	12	Customer ID to whom the invoice on account applies. Refers to customer.custid
account	String	6	Account receivable. Refers to account.account
id	String	8	ID of the invoice on account. Defined as a group of group type “INVSCR”
indexno	Int		Sequential number. Incremented for each repetitive use of the same id-custid pair
xtop	String	8	Terms of payment. Refers to xtop.id
fee	Decimal	28,8	Invoice fee
freight	Decimal	28,8	Freight
extrafee	Decimal	28,8	Administration fee
advance	Byte		1)
interval	Byte		Invoicing period, months
difference	Decimal	28,8	Difference
fixedexchange	Decimal	28,8	2)
subtype	Byte		3)
isforamount	Byte		4)
periodicmonths	Short		Number of periods for periodic allocation of the invoice row
startmonth	Short		Relative start month for performing periodic allocations
payer	String	12	Payer. Refers to customer.custid
payee	String	12	Payee. Refers to customer.custid
receiver	String	12	Receiver. Refers to customer.custid
startdate	Datetime		Start date of the invoice on account
blocked	Byte		5)
cashdiscount	String	40	Cash discount. Refers to cashdiscount.id
interest	String	40	Interest procedure. Refers to relinterest.id
yourorderno	String	40	Their order number
ourorderno	String	40	Our order number
yourreference	String	40	Their reference
yourreferencenumber	String	40	Reference number
ourreference	String	40	Our reference
enddate	Datetime		End date of the invoice on account
lastdone	Datetime		Most recent invoicing date
firstinvdate	Datetime		First date when the invoicing can be performed
doneto	Datetime		Used only internally. Specifies until which date the auto-invoicing has been
			performed
currency	String	3	Currency for invoicing. Refers to currency.currency
xfreetext	String	255	Free text for invoice header
name	String	30	Name of the invoice on account
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
mod	String	8	Method of delivery of group type “MOD”
tod	String	8	Terms of delivery of group type “TOD”
extraid	String	30	Extra ID
bankcode	String	8	National bank code of group type “BANKCODE”
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5

o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type “LEDGER1”
group2	String	64	Free group of type “LEDGER2”
language	String	8	Language code of group type “LANGID”
tradecode	Byte		Commercial code
mop	String	8	Mode of payment. Refers to mop.id
invoicingperiodstart	Datetime		Invoicing period start
invoicingperiodend	Datetime		Invoicing period end
vattype	Int		6)
rows
cid	String	8	Business unit ID
id	String	8	ID of the invoice on account. Defined as a group of group type “INVSCR”
indexno	Int		Sequential number. Incremented for each repetitive use of the same id-custid pair
custid	String	12	Customer ID to whom the invoice on account applies. Refers to customer.custid
row	Int		Row number. First row has number 0
article	String	20	Provided article
account	String	6	Sale account
vatcode	Byte		VAT code
number	Decimal	28,8	Number
amount	Decimal	28,8	Amount for each invoicing
firstamount	Decimal	28,8	First amount
lastamount	Decimal	28,8	Last amount
o1	String	64	Object of object type 1
o2	String	64	Object of object type 2
o3	String	64	Object of object type 3
o4	String	64	Object of object type 4
o5	String	64	Object of object type 5
o6	String	64	Object of object type 6
o7	String	64	Object of object type 7
o8	String	64	Object of object type 8
group1	String	64	Free group of type “VOUROW1”
group2	String	64	Free group of type “VOUROW2”
group3	String	64	Free group of type “VOUROW3”
group4	String	64	Free group of type “VOUROW4”
xfreetext	String	80	Free text for row
unit	String	8	Unit
type			7)

Value	Comment
0	invoicing is performed afterwards
1	invoicing is performed in advance

Value	Comment
0	if fixed exchange rate is not to be used for payment
1	if fixed exchange rate is to be used for payment

Value	Comment
0	for ordinary invoice
1	for candidate for summary invoice

Value	Comment
0	all amounts are in domestic currency
1	all amounts are in foreign currency

Value	Comment
0	not blocked
1	blocked (no invoices will be created)

Value	Comment
0
1	Standard
2	Vat free
3	Reverse charge

Value	Comment
0	ordinary row
1	total row, partial sum
2	total row
3	blank row

Article

Get method : /api/article/get-articles

This method will return all the articles

Field	Datatype	Size	Comment
id	String	20	Id of article
Name	String	80	Name
Artgroup	String	20	Articlegroup
Calcprice	Numeric	28,8	Calculatedprice
Unit	String	8	Unit
account1	String	6	Account
account2	String	6	Account
account3	String	6	Account
account4	String	6	Account
account5	String	6	Account
account6	String	6	Account
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
supplier	String	30	Supplierid
supplierartno	String	30	Supplier articleno
group1	String	64	From usergroups of type vourow1
group2	String	64	From usergroups of type vourow2
group3	String	64	From usergroups of type vourow4
group4	String	64	From usergroups of type vourow5
discountrow	Int		Discount
art1	String	8	From usergroups of type art1
art2	String	8	From usergroups of type art2
art3	String	8	From usergroups of type art3
art4	String	8	From usergroups of type art4
disabled	Byte		0 = not disable, 1 = disable
uac	Int		User Access Code

Get method : /api/article/get-article-by-id

This method will return one article

Inputfield	Datatype	Size	Comment
articleid	String	20	Id of article

Field	Datatype	Size	Comment
id	String	20	Id of article
Name	String	80	Name
Artgroup	String	20	Articlegroup
Calcprice	Numeric	28,8	Calculatedprice
Unit	String	8	Unit
account1	String	6	Account
account2	String	6	Account
account3	String	6	Account
account4	String	6	Account
account5	String	6	Account
account6	String	6	Account
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
supplier	String	30	Supplierid
supplierartno	String	30	Supplier articleno
group1	String	64	From usergroups of type vourow1
group2	String	64	From usergroups of type vourow2
group3	String	64	From usergroups of type vourow4
group4	String	64	From usergroups of type vourow5
discountrow	Int		Discount
art1	String	8	From usergroups of type art1
art2	String	8	From usergroups of type art2
art3	String	8	From usergroups of type art3
art4	String	8	From usergroups of type art4
disabled	Byte		0 = not disable, 1 = disable
uac	Int		User Access Code

Get method : /api/article/prices/{articleid}

This method will return article price list

Inputfield	Datatype	S	ize	Comment
articleid	String	2	0	Article Id

Field	Datatype	Size	Comment
id	String	20	Article Id
currency	String	3	Currency
Price1	Numeric	28,8	Price including tax for category 1
Price2	Numeric	28,8	Price including tax for category 2
Price3	Numeric	28,8	Price including tax for category 3
Price4	Numeric	28,8	Price including tax for category 4
Price5	Numeric	28,8	Price including tax for category 5
Price6	Numeric	28,8	Price including tax for category 6
Price7	Numeric	28,8	Price including tax for category 7
Price8	Numeric	28,8	Price including tax for category 8
swapDate	DateTime		Date when price list price1 – price8 switches to price list swap1 – swap8
swap1	Numeric	28,8	Price including tax for category 1, after swap date
swap2	Numeric	28,8	Price including tax for category 2, after swap date
swap3	Numeric	28,8	Price including tax for category 3, after swap date
swap4	Numeric	28,8	Price including tax for category 4, after swap date
swap5	Numeric	28,8	Price including tax for category 5, after swap date
swap6	Numeric	28,8	Price including tax for category 6, after swap date
swap7	Numeric	28,8	Price including tax for category 7, after swap date
swap8	Numeric	28,8	Price including tax for category 8, after swap date

Get method : /api/article/price

This method will return article price list

Inputfield	Datatype	S	ize	Comment
articleid	String	2	0	Article Id
customerid	String	12	Customer Id

Field	Datatype	Size	Comment
id	String	20	Article Id
currency	String	3	Currency
price	Numeric	28,8	Article price
swapPrice	Numeric	28,8	Swap price depending on customer setting
swapDate	DateTime		Swap date

Post method : /api/article/price

This method will create or updates one article pris identified by article price id and currency

Inputfield	Datatype	Size	Comment
id	String	20	Article Id
currency	String	3	Currency. If currency is domestic then set currency = [*]
Price1	Numeric	28,8	Price including tax for category 1
Price2	Numeric	28,8	Price including tax for category 2
Price3	Numeric	28,8	Price including tax for category 3
Price4	Numeric	28,8	Price including tax for category 4
Price5	Numeric	28,8	Price including tax for category 5
Price6	Numeric	28,8	Price including tax for category 6
Price7	Numeric	28,8	Price including tax for category 7
Price8	Numeric	28,8	Price including tax for category 8
swapDate	DateTime		Date when price list price1 – price8 switches to price list swap1 – swap8
swap1	Numeric	28,8	Price including tax for category 1, after swap date
swap2	Numeric	28,8	Price including tax for category 2, after swap date
swap3	Numeric	28,8	Price including tax for category 3, after swap date
swap4	Numeric	28,8	Price including tax for category 4, after swap date
swap5	Numeric	28,8	Price including tax for category 5, after swap date
swap6	Numeric	28,8	Price including tax for category 6, after swap date
swap7	Numeric	28,8	Price including tax for category 7, after swap date
swap8	Numeric	28,8	Price including tax for category 8, after swap date

Field	Datatype	Size	Comment
	Bool		True/False

Get method : /api/article/all

This method will return all article prices

Inputfield	Datatype	Size	Comment
page	Int		Page to fetch. First page = 0

Field	Datatype	Size	Comment
id	String	20	Article Id
currency	String	3	Currency
Price1	Numeric	28,8	Price including tax for category 1
Price2	Numeric	28,8	Price including tax for category 2
Price3	Numeric	28,8	Price including tax for category 3
Price4	Numeric	28,8	Price including tax for category 4
Price5	Numeric	28,8	Price including tax for category 5
Price6	Numeric	28,8	Price including tax for category 6
Price7	Numeric	28,8	Price including tax for category 7
Price8	Numeric	28,8	Price including tax for category 8
swapDate	DateTime		Date when price list price1 – price8 switches to price list swap1 – swap8
swap1	Numeric	28,8	Price including tax for category 1, after swap date
swap2	Numeric	28,8	Price including tax for category 2, after swap date
swap3	Numeric	28,8	Price including tax for category 3, after swap date
swap4	Numeric	28,8	Price including tax for category 4, after swap date
swap5	Numeric	28,8	Price including tax for category 5, after swap date
swap6	Numeric	28,8	Price including tax for category 6, after swap date
swap7	Numeric	28,8	Price including tax for category 7, after swap date
swap8	Numeric	28,8	Price including tax for category 8, after swap date

Post method : /api/article/create-or-update-article

This method will create or update an article

Inputfield	Datatype	Size	Comment
id	String	20	Id of article
Name	String	80	Name
Artgroup	String	20	Articlegroup
Calcprice	Numeric	28,8	Calculatedprice
Unit	String	8	Unit
account1	String	6	Account
account2	String	6	Account
account3	String	6	Account
account4	String	6	Account
account5	String	6	Account
account6	String	6	Account
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
supplier	String	30	Supplierid
supplierartno	String	30	Supplier articleno
group1	String	64	From usergroups of type vourow1
group2	String	64	From usergroups of type vourow2
group3	String	64	From usergroups of type vourow4
group4	String	64	From usergroups of type vourow5
discountrow	Int		Discount
art1	String	8	From usergroups of type art1
art2	String	8	From usergroups of type art2
art3	String	8	From usergroups of type art3
art4	String	8	From usergroups of type art4
disabled	Byte		0 = not disable, 1 = disable
uac	Int		User Access Code

Attachment

Get method : /api/attachment/download-attachment

This method will return the binarydata of the file

Inputfield	Datatype	Comment
id	String	Attachment internal id
fileName	String	Filename

Field	Datatype	Comment
Content	Byte[]	File content
ContentType	String	Filetype

Post method : /api/attachment/invoice/{invserie}/{invnumber}

This method uploads an invoice attachment

Inputfield	Datatype	Comment
invserie	String	Invoice serie
invnumber	Int	Invoice number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Post method : /api/attachment/invoice-log/{invserie}/{invnumber}

This method uploads an invoice log attachment

Inputfield	Datatype	Size	Comment
invserie	String	8	Invoice log serie
invnumber	Int	Invoice log number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/invoice-log/{invserie}/{invnumber}

This method returns the attachment file name and attachment Id of an invoice log

Inputfield	Datatype	Size	Comment
invserie	String	8	Invoice log serie
invnumber	Int	Invoice log number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/sales-ledger/{enumerator}/{invno}

This method uploads a sales ledger attachment

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger serie
invno	Int	Ledger number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/sales-ledger/{enumerator}/{invno}

This method returns the attachment file name and attachment Id of a sales ledger

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger serie
invno	Int	Ledger number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/sales-ledger-log/{enumerator}/{invno}

This method uploads a sales ledger log attachment

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger serie
invno	Int	Ledger number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/sales-ledger-log/{enumerator}/{invno}

This method returns the attachment file name and attachment Id of a sales ledger log

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger log serie
invno	Int	Ledger log number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/supplier-ledger/{enumerator}/{invno}

This method uploads a sales ledger attachment

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger serie
invno	Int	Ledger number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/supplier-ledger/{enumerator}/{invno}

This method returns the attachment file name and attachment Id of a supplier ledger

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger log serie
invno	Int	Ledger log number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/supplier-ledger-log/{enumerator}/{invno}

This method uploads a sales ledger log attachment

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger log serie
invno	Int	Ledger log number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/supplier-ledger-log/{enumerator}/{invno}

This method returns the attachment file name and attachment Id of a sales ledger log

Inputfield	Datatype	Size	Comment
enumerator	String	8	Ledger log serie
invno	Int	Ledger log number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/voucher/{vouno}/{serie}/{year}

This method uploads a voucher attachment

Inputfield	Datatype	Size	Comment
vouno	Int		Voucher number
serie	String	8	Voucher serie
year	Int		Voucher year
file	Byte[]		Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Post method : /api/attachment/voucher-log/{logno}

This method uploads a voucher log attachment

Inputfield	Datatype	Comment
logno	Int	Voucher log number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/voucher-log/{logno}

This method returns a list with attachment filenames and attachment Ids for voucher logs

Inputfield	Datatype	Comment
logno	Int	Voucher log number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/asset/{assetno}

This method uploads an asset attachment

Inputfield	Datatype	Comment
assetno	Int	Asset number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/asset/{assetno}

This method returns the attachment file name and attachment Id of an asset

Inputfield	Datatype	Comment
assetno	Int	Asset number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/voucher-row/{vouno}/{serie}/{year}/{rowno}

This method uploads a voucher row attachment

Inputfield	Datatype	Comment
vouno	Int	Voucher number
serie	String	Voucher serie
year	Int	Voucher year
rowno	Int	Voucher row number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Post method : /api/attachment/voucher-row-log/{logno}/{logrow}

This method uploads a voucher row attachment

Inputfield	Datatype	Comment
logno	Int	Voucher row log number
logrow	Int	Voucher row log row number
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message succesfull

Get method : /api/attachment/voucher-row-log/{logno}/{logrow}

This method returns a list with attachment file names and attachment Ids for voucher row logs

Inputfield	Datatype	Comment
logno	Int	Voucher row log number
logrow	Int	Voucher row log row number

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Get method : /api/attachment/get-voucher-attachments

This method returns a list with attachment file names and attachment Ids of a voucher

Inputfield	Datatype	Size	Comment
vouno	Int		Voucher number
serie	String	8	Voucher serie
yearno	Int		Voucher year

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Get method : /api/attachment/get-voucher-row-attachments

This method returns a list with attachment file names and attachment Ids for voucher rows

Inputfield	Datatype	Size	Comment
vouno	Int		Voucher number
serie	String	8	Voucher serie
yearno	Int		Voucher year
rowno	Int		Voucher row number(0,1,2…)

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Get method : /api/attachment/get-invoice-attachment

This method returns the attachment file name and attachment Id of an invoice

Inputfield	Datatype	Size	Comment
invnumber	Int		Invoice number
invserie	String	8	Invoice serie

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Post method : /api/attachment/agreement/{agreementid}/{custid}/{indexno}

This method uploads a agreement attachment

Inputfield	Datatype	Comment
agreementid	String	ID of the invoice on account. Defined as a group of group type “INVSCR”
custid	String	Customer ID to whom the invoice on account applies. Refers to customer.custid
indexno	Int	Sequential number. Incremented for each repetitive use of the same id-custid pair
file	Byte[]	Filecontent

Field	Datatype	Comment
Message	String	If succesfull then a message successful

Get method : /api/attachment/agreement/{agreementid}/{custid}/{indexno}

This method returns the attachment file name and attachment Id of an agreement

Inputfield	Datatype	Size	Comment
agreementid	String	8	ID of the invoice on account. Defined as a group of group type “INVSCR”
custid	String	12	Customer ID to whom the invoice on account applies. Refers to customer.custid
indexno	Int		Sequential number. Incremented for each repetitive use of the same id-custid pair

Field	Datatype	Comment
filename	String	Name of file
id	String	Id of file

Budget

Post method: /api/budget/create-budget

This method creates a new budget entry

Inputfield	Datatype	Size	Comment
businessUnit	String	8	Business unit ID
Year	Short		Year
period	Byte		Period
budgetType	Short		1)
amount	Numeric	28,8	Amount
foreignAmount	Numeric	28,8	Foreign amount
number	Numeric	28,8	Number
account	String	6	Account
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
distributionKey	String	8	Distribution key that is used for the budget. Value is set to NULL for balance container

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget

Get method: /api/budget

This method retrieves budget details based on business unit, budget type, year, start period and end

period

Field	Datatype	Size	Comment
businessUnit	String	8	Business unit ID
type	Int	1)
year	Int	Year
periodFrom	Int	Start period
periodTo	Int	End period
showPreviusYearOutcome	Bool	True/False

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget

Field	Datatype	Size	Comment
Year	Short		Year
period	Byte		Period
account	String	6	Account
currency	String	3	Currency
foreignAmount	Numeric	28,8	Foreign amount
number	Numeric	28,8	Number
amount	Numeric	28,8	Amount
baseCurrency	Numeric	28,8	Alternative currency
baseAmount	Numeric	28,8	Amount in alternative currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucher serie. Specified only for simulation vouchers, otherwise the value is set to NULL
distibutionKey	String		Distribution key that is used for the budget. Value is set to NULL for
			balance container
recalculationFactor	Numeric	28,8	Factor for budget amount. From xsys
previousYearAmount	Numeric	28,8	Amount
previousYearForAmount	Numeric	28,8	Amount
previousYearNumber	Numeric	28,8	Year

Get method: /api/budget/year

This method retrieves budget items per year

Field	Datatype	Size	Comment
List:
businessUnit	String	8	Business unit ID
year	Int		Year
amount	Numeric	28,8	Amount
budgetTypeId	String	8	Budget Id
budgetTypeName	String	30	Name

Budgettype

Get method: /api/budgettype/get-budgettype-by-physical-number

This method gets the budgettype based on the physical number

Inputfield	Datatype	Size	Comment
number	Int		Budgettype number

Field	Datatype	Comment
budgettypeID	String	Budget number
budgettypeName	String	Budget type name
distributionKey	String	Default distribution key
yearID	Int	Year for which the budget is used

BusinessUnit

Get method : /api/businessunit/get-businessunits

This method will return a list of Companies

Field	Datatype	Size	Comment
no	String	8	Companyid
name	String	30	Name of company
address1	String	40	Address field 1
address2	String	40	Address field 2
address3	String	40	Address field 3
address4	String	40	Address field 4
phone1	String	30	Phone field 1
phone2	String	30	Phone field 2
phone3	String	30	Phone field 3
number	String	30	Company regnumber
vatno	String	30	Vatregistrationnumber
companytype	String	20	Type of business
missiontype	String	20	Task type
branchtype	String	20	Branch of industry
firstreg	Datetime		First action
lastreg	Datetime		Latest action
endperiod	String	8	Period when the accounting year ends
vatperiods	Byte		Number of periods in each VAT reporting block
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Group of type CLIENT1
group2	String	64	Group of type CLIENT2
group3	String	64	Group of type CLIENT3
group4	String	64	Group of type CLIENT4
group5	String	64	Group of type CLIENT5
group6	String	64	Group of type CLIENT6
group7	String	64	Group of type CLIENT7
group8	String	64	Group of type CLIENT8

group9	String	64	Group of type CLIENT9
group10	String	64	Group of type CLIENT10
group11	String	64	Group of type CLIENT11
group12	String	64	Group of type CLIENT12
group13	String	64	Group of type CLIENT13
group14	String	64	Group of type CLIENT14
group15	String	64	Group of type CLIENT15
group16	String	64	Group of type CLIENT16
group17	String	64	Group of type CLIENT17
group18	String	64	Group of type CLIENT18
group19	String	64	Group of type CLIENT19
group20	String	64	Group of type CLIENT20
disabled	Datetime		When company is disabled from
basecurrency	String	3	Alternative currency
countrycode	String	8	Country code

Get method : /api/bank/businessunit/{businessUnitId}

This method will return a list of banks based on businessUnitId

Inputfield	Datatype	Size	Comment
businessUnitId	String	8	Companyid

Field	Datatype	Size	Comment
id	String	8	Bank ID.
type	Int		1)
mop	String	8	Associated mode of payment. Refers to mop.id.
owner	String	12	Bank owner ID.
bankType	String	8	Bank type of group “BANKTYPE”.
number	String	40	Account number.
swift	String	30	Swift address.
clearing	String	30	Clearing number.
bankName	String	30	Bank name.
freeText	String	255	Free text.
address1	String	40	First address.
address1	String	40	Second address.
address1	String	40	Third address.
address1	String	40	Fourth address.
group1	String	64	Group of group type “BANK1”.
Group2	String	64	Group of group type “BANK2”.
Group3	String	64	Group of group type “BANK3”.
Group4	String	64	Group of group type “BANK4”.
defBank	Byte	1	2)
paymentaccount	String	6	Payment account. Refers to account.account. This paymentaccount is used for paymenet with Autopay i.e mode of payment VOP
currency	String	8	Currency

Value	Comment
1	Customer (not used)
-1	Supplier
0	Company

Value	Comment
1	bank is not a default bank
0	bank is a default bank

Cashflow

Get method : /api/cashflow/{id}

This method will retrieve cashflow details based on the provided cashflow ID

Inputfield	Datatype	S	ize	Comment
id	Int			Cashflow item id

Field	Datatype	Size	Comment
businessUnit	String	8	Business Unit Id
date	Datetime		Duedate
type	Byte		Type of cashflow item
currency	String	3	Currency
amount	Numeric	28,8	Amount
foramount	Numeric	28,8	Foregin amount
name	String	80	Name
id	Int		Cashflow item id

Patch method : /api/cashflow/{id}

This method updates a cashflow item

Inputfield	Datatype	S	ize	Comment
id	Int			Cashflow item id

Post method : /api/cashflow/no-recurrence This method creates a cashflow item with no recurrence. Post method : /api/cashflow/weekly-recurrence This method creates a cashflow item with weekly recurrence. 45

Post method : /api/cashflow/monthly-recurrence-by-day This method creates/updates a monthly cashflow for the X-th day of every Y month. Post method : /api/cashflow/monthly-recurrence This method creates/updates a monthly cashflow item for the N-th occurrence of [Weekday] in every Y month. 46

Container

Get method : /api/container/get-byyear

This method returns a list of containers for a year with start and end periods

Inputfield	Datatype	Comment
year	Int	Year number
startPeriod	Int	Start period number
endPeriod	Int	End period number
page	Int	0 is first page

Field	Datatype	Size	Comment
id	Int		Dummy used for indexing
baseamount	Decimal	28,8	Alternativ amount
period	Byte		Period (1 – 12)
type	Short		1)
account	String	6	Account. Must exist in accountx
cid	String	8	Company
year	Short		Year. Same as yearno in periodx
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
basecurrency	String	3	Alternative currency
model	String	8	Distribution key used for budget
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucherserie
flag	Byte		2)
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget
5	Range is used for varius budget types

Value	Comment
0	Budget doesn’t update the year balance
1	Budget updates the year balance

Get method : /api/container/get-byyeartype

This method returns a list of containers based on the year number and type

Inputfield	Datatype	Comment
year	Int	Year number
type	Int	1)
page	Int	0 is first page

Field	Datatype	Size	Comment
id	Int		Dummy used for indexing
baseamount	Decimal	28,8	Alternativ amount
period	Byte		Period (1 – 12)
type	Short		1)
account	String	6	Account. Must exist in accountx
cid	String	8	Company
year	Short		Year. Same as yearno in periodx
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
basecurrency	String	3	Alternative currency
model	String	8	Distribution key used for budget
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucherserie
flag	Byte		2)
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget
5	Range is used for varius budget types

Value	Comment
0	Budget doesn’t update the year balance
1	Budget updates the year balance

Get method : /api/container/get-byyeartypeperiod

This method returns a list of containers based on the year number, type, start period and end period

Inputfield	Datatype	Comment
year	Int	Year number
type	Int	1)
startPeriod	Int	Start period number
endPeriod	Int	End period number
page	Int	0 is first page

Field	Datatype	Size	Comment
id	Int		Dummy used for indexing
baseamount	Decimal	28,8	Alternativ amount
period	Byte		Period (1 – 12)
type	Short		1)
account	String	6	Account. Must exist in accountx
cid	String	8	Company
year	Short		Year. Same as yearno in periodx
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
basecurrency	String	3	Alternative currency
model	String	8	Distribution key used for budget
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucherserie
flag	Byte		2)
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget
5	Range is used for varius budget types

Value	Comment
0	Budget doesn’t update the year balance
1	Budget updates the year balance

Get method : /api/container/get-container-by-budgettype

This method returns a list of containers based on the type

Inputfield	Datatype	Comment
type	Int	1)
page	Int	0 is first page

Field	Datatype	Size	Comment
id	Int		Dummy used for indexing
baseamount	Decimal	28,8	Alternativ amount
period	Byte		Period (1 – 12)
type	Short		1)
account	String	6	Account. Must exist in accountx
cid	String	8	Company
year	Short		Year. Same as yearno in periodx
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
basecurrency	String	3	Alternative currency
model	String	8	Distribution key used for budget
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucherserie
flag	Byte		2)
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget
5	Range is used for varius budget types

Value	Comment
0	Budget doesn’t update the year balance
1	Budget updates the year balance

Post method : /api/container/filter

This method returns a list of containers based on filter

Filter

Input	Datatype	Comment
filters:
fieldName	String	1)
operator	Enum	2)
value	String
secondValue	String
page	Int	Page to fetch. First page = 0

1) Field Period Type Account Cid Amount Foramount Model Currency O1 O2 O3 O4 O5 O6 O7 O8 Serie 2)

Operator	Comment
Equal	Exact match
Include	In operation with comma-seperated values
Between	Range between two values (requires secondvalue)
GreaterThan	Greater than comparison
LessThan	Less than comparison

Field	Datatype	Size	Comment
list:
id	Int		Dummy used for indexing
baseamount	Decimal	28,8	Alternativ amount
period	Byte		Period (1 – 12)
type	Short		1)
account	String	6	Account. Must exist in accountx
cid	String	8	Company
year	Short		Year. Same as yearno in periodx
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
basecurrency	String	3	Alternative currency
model	String	8	Distribution key used for budget
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
serie	String	8	Voucherserie
flag	Byte		2)
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch
totalNumberOfRecords	String

Value	Comment
0	Previus year result
1	Opening balance
9	Period balance
10	Simulation vouchers
100 - 30000	If account is used for budget
5	Range is used for varius budget types

Value	Comment
0	Budget doesn’t update the year balance
1	Budget updates the year balance

Currency

Get method : /api/currency/get-currencies

This method returns a list of all currencies

Field	Datatype	Size	Comment
currencyId	String	3	Id
description	String	30	Description
recalc1	Decimal	28,8	Purchase price, first recalculation
recalc2	Decimal	28,8	Purchase price, second recalculation
recalc3	Decimal	28,8	Sales price, first recalculation
recalc4	Decimal	28,8	Sales price, second recalculation
changed	Datetime		Date of last modification
recalcAccount	String	6	Account. Must exist in accountx
linked	String	3	Currency linked to the current one

Get method : /api/currency/get-currencies-with-rates

This method returns a list of all currencies with exchangerates

Field	Datatype	Size	Comment
currencyId	String	3	Id
description	String	30	Description
recalc1	Decimal	28,8	Purchase price, first recalculation
recalc2	Decimal	28,8	Purchase price, second recalculation
recalc3	Decimal	28,8	Sales price, first recalculation
recalc4	Decimal	28,8	Sales price, second recalculation
Changed	Datetime		Date of last modification
recalcAccount	String	6	Account. Must exist in account
Linked	String	3	Currency linked to the current one
sellExchange	Decimal	28,8	Sale price
buyExchange	Decimal	28,8	Purchase price
validFrom	Datetime		Exchange rate start date

Post method : /api/currency-rate

This method adds an exchange rate for currency

Inputfield	Datatype	Size	Comment
currency	String	3	Currency
validfrom	Datetime		Valid from date
buyexchange	Decimal	28,8	Purchase price
sellexchange	Decimal	28,8	Sale price

Field	Datatype	Size	Comment
entityId	String		Currency Id
entityType	String	Type of entity

FixedAsset

Get method : /api/asset/get-assets

This method will return a list of fixed assets

Field	Datatype		Comment
noapartments	Int
assetcategory	Byte		Assetcategory
assetstatus	Byte		1)
cid	String	8	Company
ownerassetno	Int		Owner assetno, or -1 if there is no owner
assetno	Int		Assetid
buyamount	Decimal	28,8	Purchase amount
extraamount1	Decimal	28,8	Extra amount
extraamount2	Decimal	28,8	Extra amount
sellvouno	Int		Vouchernumber if asset sold
insuranceamount	Decimal	28,8	Insurance amount
replacementvalue	Decimal	28,8	Replacement value
estsellamount	Decimal	28,8	Estimated sell amount
taxvalueyear	Short		Year of valuation
taxvaluedwelling	Decimal	28,8	Tax value for buildings
taxvaluepremesis	Decimal	28,8	Tax value for premises
taxvaluehouse	Decimal	28,8	Tax value
taxvaluehouseland	Decimal	28,8	Tax value
taxvalueapartmentland	Decimal	28,8	Tax value
taxvaluefacility	Decimal	28,8	Tax value
uac	Int		Tax value for facility
buyforamount	Decimal	28,8	Purchase forign amount
sellamount	Decimal	28,8	Sell amount
sellvoutype	String	8	Voucherserie for sell voucher
selldate	Datetime		Date for asset sale/discarding
o1debit	String	64	Debet object 1 for internal interest
o2debit	String	64	Debet object 2 for internal interest
o3debit	String	64	Debet object 3 for internal interest
o4debit	String	64	Debet object 4 for internal interest
o5debit	String	64	Debet object 5 for internal interest
o6debit	String	64	Debet object 6 for internal interest
o7debit	String	64	Debet object 7 for internal interest
o8debit	String	64	Debet object 8 for internal interest
o1credit	String	64	Credit object 1 for internal interest
o2credit	String	64	Credit object 2 for internal interest
o3credit	String	64	Credit object 3 for internal interest
o4credit	String	64	Credit object 4 for internal interest
o5credit	String	64	Credit object 5 for internal interest
o6credit	String	64	Credit object 6 for internal interest
o7credit	String	64	Credit object 7 for internal interest
o8credit	String	64	Credit object 8 for internal interest
intdebitacc	String	6	Debet account for internal interest
intcreditacc	String	6	Credit account for internal interest
intid	String	8	Interest procedure for internal interest
propown	String	8	Type of ownership for real estate. Group of type ASSOWNER
propcode	String	8	Type for real estate. Group of type ASSBUILD
intintstartdate	Datetime		Startdate for internal rate calculation
intintlatestuse	Datetime		Most recent date of internal interest rate booking
changed	Datetime		Date of latest change of asset
statuschanged	Datetime		Date of lastest change of status
suppid	String	12	Supplier id. Must exist in person table
supplier	String	80	Name of supplier
label	String	30	Marking
responsible	String	8	Administrator
location1	String	30	Location (eg room). Group of type ASSLOC1
location2	String	30	Location (eg buildning). Group of type ASSLOC2
group1	String	64	Group of type ASSET1
group2	String	64	Group of type ASSET3

group3	String	64	Group of type ASSET3
group4	String	64	Group of type ASSET4
freetext1	String	30	Free text 1
freetext2	String	30	Free text 2
freetext3	String	30	Free text 3
freetext4	String	30	Free text 4
o1	String	64	Object 1 for assets
o2	String	64	Object 2 for assets
o3	String	64	Object 3 for assets
o4	String	64	Object 4 for assets
o5	String	64	Object 5 for assets
o6	String	64	Object 61 for assets
o7	String	64	Object 7 for assets
o8	String	64	Object 8 for assets
buycurrency	String	3	Purchase currency
assettype	String	8	Assettype. Refers to assettype.assettype
name	String	30	Name of asset
description	String	30	Description of asset
buydate	Datetime		Purchase date

Value	Comment
1	Preliminary
10	Owned, for use
11	Owned, not for use
12	Owned, non-accountable
50	Not owned, borrowed/insured
51	Not owned, leased/insured
90	Owned, fully depricated
91	Sold
92	Missing
93	Stolen
94	Returned back
99	Counter-booked

Get method : /api/asset/get-history

This method returns a list of history for an asset

Inputfield	Datatype	Comment
assetid	Int	Asset id

Field	Datatype	Size	Comment
id	Int		Identity column
assetno	Int		Id of asset
actiondate	Datetime		Date of log entry
actiontype	Byte		1)
vouno	Int		Vouchernumber
amount	Decimal	28,8	Amount
bookdate	Datetime		Accountingdate
info	String	80	Event information
voutype	String	8	Voucherserie

Value	Comment
1	Asset creation/purchase
2	Depreciation
3	Edit of depreciation
4	Property tax booking
5	Edit of property tax
6	Write up/down
7	Sale of fixed asset
8	Discard of fixed asset
9	Internal interest booking
10	Edit of internal interest
11	Split of fixed asset
12	Merge of fixed asset
13	Registration of previous depreciations

Get method : /api/asset/get-all-history-by-year

This method returns a list of history for assets based on year

Inputfield	Datatype	Comment
year	Int	Year number
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
id	Int		Identity column
assetno	Int		Id of asset
actiondate	Datetime		Date of log entry
actiontype	Byte		1)
vouno	Int		Vouchernumber
amount	Decimal	28,8	Amount
bookdate	Datetime		Accountingdate
info	String	80	Event information
voutype	String	8	Voucherserie
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
1	Asset creation/purchase
2	Depreciation
3	Edit of depreciation
4	Property tax booking
5	Edit of property tax
6	Write up/down
7	Sale of fixed asset
8	Discard of fixed asset
9	Internal interest booking
10	Edit of internal interest
11	Split of fixed asset
12	Merge of fixed asset
13	Registration of previous depreciations

Get method : /api/asset/get-all-history

This method returns a list of history for assets

Inputfield	Datatype	Comment
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
id	Int		Identity column
assetno	Int		Id of asset
actiondate	Datetime		Date of log entry
actiontype	Byte		1)
vouno	Int		Vouchernumber
amount	Decimal	28,8	Amount
bookdate	Datetime		Accountingdate
info	String	80	Event information
voutype	String	8	Voucherserie
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
1	Asset creation/purchase
2	Depreciation
3	Edit of depreciation
4	Property tax booking
5	Edit of property tax
6	Write up/down
7	Sale of fixed asset
8	Discard of fixed asset
9	Internal interest booking
10	Edit of internal interest
11	Split of fixed asset
12	Merge of fixed asset
13	Registration of previous depreciations

Get method : /api/asset/get-history-by-changedate

This method returns a list of history for assets

Inputfield	Datatype	Comment
changeDate	Datetime	Asset changedate
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
id	Int		Identity column
assetno	Int		Id of asset
actiondate	Datetime		Date of log entry
actiontype	Byte		1)
vouno	Int		Vouchernumber
amount	Decimal	28,8	Amount
bookdate	Datetie		Accountingdate
info	String	80	Event information
voutype	String	8	Voucherserie
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
1	Asset creation/purchase
2	Depreciation
3	Edit of depreciation
4	Property tax booking
5	Edit of property tax
6	Write up/down
7	Sale of fixed asset
8	Discard of fixed asset
9	Internal interest booking
10	Edit of internal interest
11	Split of fixed asset
12	Merge of fixed asset
13	Registration of previous depreciations

Get method : /api/asset/get-categories

This method returns a list of asset categories

Field	Datatype	Size	Comment
depreciatable	Byte		1)
taxdepreciatable	Byte		2)
taxable	Byte		3)
assetcategory1	Byte		4)
name	String	40	Category name

Value	Comment
1	Depreciatable inventory
2	Non-depreciatable inventory
3	Real estate / building
4	Real estate / markanläggning
5	Real estate / mark

Value	Comment
0	if assets of the category cannot be depreciated
1	if assets of the category can be depreciated

Value	Comment
0	if assets of the category aren’t subject to tax depreciations
1	if assets of the category are subject to tax depreciations

Value	Comment
0	if assets of the category aren’t subject to property taxes
1	if assets of the category are subject to property taxes

Get method : /api/asset/get-types

This method returns a list of asset types

Field	Datatype	Size	Comment
assettype1	String	8	Asset type id
assetcategory	Byte		1)
name	String	30	Asset type name
buyaccount	String	6	Purchase account
salesaccount	String	6	Sales account
profitaccount	String	6	Profit account
lossaccount	String	6	Loss account
upaccount	String	6	Write-up account
downaccount	String	6	Write-down account
updownoffsetaccount	String	6	Contra account write-up/write-down
o1debit	String	64	Debet object 1 for internal interest
o2debit	String	64	Debet object 2 for internal interest
o3debit	String	64	Debet object 3 for internal interest
o4debit	String	64	Debet object 4 for internal interest
o5debit	String	64	Debet object 5 for internal interest
o6debit	String	64	Debet object 6 for internal interest
o7debit	String	64	Debet object 7 for internal interest
o8debit	String	64	Debet object 8 for internal interest
o1credit	String	64	Credit object 1 for internal interest
o2credit	String	64	Credit object 2 for internal interest
o3credit	String	64	Credit object 3 for internal interest
o4credit	String	64	Credit object 4 for internal interest
o5credit	String	64	Credit object 5 for internal interest
o6credit	String	64	Credit object 6 for internal interest
o7credit	String	64	Credit object 7 for internal interest
o8credit	String	64	Credit object 8 for internal interest
intdebitacc	String	6	Debet account for internal interest
intcreditacc	String	6	Credit account for internal interests
intid	String	8	Interest procedure for internal interests

Value	Comment
1	Depreciatable inventory
2	Non-depreciatable inventory
3	Real estate / building
4	Real estate / markanläggning
5	Real estate / mark

Get method : /api/asset/get-statuses

This method returns a list of asset status

Field	Datatype	Size	Comment
assetstatus1	Byte		1)
name	String	40	Name

Value	Comment
1	Preliminary
10	Owned, for use
11	Owned, not for use
12	Owned, non-accountable
50	Not owned, borrowed/insured
51	Not owned, leased/insured
90	Owned, fully depricated
91	Sold
92	Missing
93	Stolen
94	Returned back
99	Counter-booked

Get method : /api/asset/get-deprecproc

This method returns a list of asset depreciation procedures

Field	Datatype	Size	Comment
deprecproc1	Byte		1)
class	Byte		2)
calctype	Byte		3)
daybased	Byte		4)
storedproc	String	80	Name of the stored procedure for user-defined methods of depreciation
name	String	40	Name

Value	Comment
1	depreciation according to plan / period
2	depreciation according to plan / date
3	percentage depreciation / period
4	percentage depreciation / date
5	end date depreciation / period
6	end date depreciation / date
7	tax depreciation / period
8	tax depreciation / date
	User-defined depreciation methods should start with ID = 100

Value	Comment
1	accounting depreciation
2	tax depreciation

Value	Comment
1	according to plan
2	percentage
3	end date
4	no parameters (e.g. 30/20-rule)

Value	Comment
0	if calculation is based on whole periods
1	calculation is day-based

Get method : /api/asset/get-deprectypes

This method returns a list of asset depreciation types

Field	Datatype	Size	Comment
deprectype1	String	8	Depreciation type id
deprecproc	Byte		Depreciation method
years	Int		Number of years for the depreciation methods according to plan
percentage	Decimal	28,8	Percentage for percentage-depreciation methohs
name	String	30	Name

Get method : /api/asset/get-deprecrules

This method returns a list of asset depreciation rules

Field	Datatype	Size	Comment
deprecproc1	Byte		Depreciation method of the depreciation type. Refers to deprectype.deprecproc
assetNo	Int		Asset id
deprectype	String	8	Depreciation type ID to which the rule belongs. Refers to deprectype.deprectype
startdate	Datetime		Start date for depreciation
balanceaccount	String	6	Balance account for the created vouchers
balanceo1	String	64	Balance object 1 for the created vouchers
balanceo2	String	64	Balance object 2 for the created vouchers
balanceo3	String	64	Balance object 3 for the created vouchers
balanceo4	String	64	Balance object 4 for the created vouchers
balanceo5	String	64	Balance object 5 for the created vouchers
balanceo6	String	64	Balance object 6 for the created vouchers
balanceo7	String	64	Balance object 7 for the created vouchers
balanceo8	String	64	Balance object 8 for the created vouchers
resultaccount	String	6	Profit/loss account for the created vouchers
resulto1	String	64	Profit/loss object 1 for the created vouchers
resulto2	String	64	Profit/loss object 2 for the created vouchers
resulto3	String	64	Profit/loss object 3 for the created vouchers
resulto4	String	64	Profit/loss object 4 for the created vouchers
resulto5	String	64	Profit/loss object 5 for the created vouchers
resulto6	String	64	Profit/loss object 6 for the created vouchers
resulto7	String	64	Profit/loss object 7 for the created vouchers
resulto8	String	64	Profit/loss object 8 for the created vouchers
latestuse	Datetime		Most recent use of the depreciation rule
percentage	Float		Percentage for percentage-type depreciation rules
enddate	Datetime		End date for the end-date-type depreciation rules
minresidual	Float		Minimal residual value
prevdeprecstart	Datetime		Date of the previous depreciation
prevdeprecamount	Float		Amount of the previous depreciation
ruledone	Int		0 – rule is done. 1 – rule is active

GroupType

Get method : /api/grouptype/get-grouptypes

This method will return a list of usergroups

Inputfield	Datatype	Comment
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	8	Group id
uac	Int		User Access Code
groupdesc	String	20	Description
text	String	80	Freetext for group
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Invoice

Get method : /api/invoice/get-types

This method will return a list of invoice types

Field	Datatype	Size	Comment
type	Short		1)
usertype	String	2	Name
interest	Byte		2)
sort	Byte		Iternal sort item
description	String	20	Description

Value	Comment
1	invoice, customer invoice
2	credit, customer invoice
3	interest invoice, customer invoice
4	interest credit, customer invoice
5	on account, customer invoice
6	advance, customer invoice
10	final payment, customer invoice
11	partial payment, customer invoice
12	difference, customer invoice
13	cash discount, customer invoice
14	fee, customer invoice
15	matching, customer invoice
16	currency profit, customer invoice
17	currency loss, customer invoice
-1	invoice, supplier ledger
-2	credit, supplier ledger
-3	on account, supplier ledger
-4	advance, supplier ledger
-10	final payment, supplier ledger
-11	partial payment, supplier ledger
-12	difference, supplier ledger
-13	cash discount, supplier ledger
-14	matching, supplier ledger
-15	currency profit, supplier ledger
-16	currency loss, supplier ledger

Value	Comment
0	invoice type does not trigger generation of interests
1	invoice type can trigger generation of interests

Get method : /api/invoice/get-invoicestatus

Returns the invoice statuses that were changes since the last time the endpoint was called

Field	Datatype		Comment
invoiceSerie	String	8	Invoive serie
invoiceNumber	String		Invoice number
status	Int		1)

Value	Comment
0	preliminary invoice
1	booked invoice
2	printed invoice

Get method : /api/invoice/get-paidstatus

Returns the invoice statuses that were changes since the last time the endpoint was called

Inputfield	Datatype	Comment
startDate	Datetime

Field	Datatype	Size	Comment
invoiceSerie	String	8	Invoive serie
invoiceNumber	String	Invoice number
status	Int	1)

Value	Comment
0	preliminary invoice
1	booked invoice
2	printed invoice

Get method : /api/invoice/list

Returns a list of invoices between two invoice dates. The list can be filtered by status

Inputfield	Datatype	Comment
fromInvoiceDate	DatetTime	From date
toInvoiceDate	DateTime	To date
status	Int	1)

Value	Comment
0	preliminary invoice
1	booked invoice
2	printed invoice

Field	Datatype	Size	Comment
businessUnit	String	8	Company. Refers to client.no
invoiceSerie	String	8	Invoice serie
invoiceNumber	Int	12	Invoicenumber
customer	String	40	Customer id. Refers to person.id
payer	String	12	Payer ID, refers to person.id.
payee	String	12	Payee ID, refers to person.id.
receiver	String	12	Receiver ID, refers to person.id.
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
xTop	String	8	Terms of payment, refers to xtop.id.
mop	String	8	Mode of payment, refers to mop.id.
invoiceDate	Datetime		Invoicing date.
dueDate	Datetime		Due date.
invoiceType	Byte		1)
subType	Byte		2)
fee	Decimal	28,8	Invoice fee in foreign amount, including tax.
freight	Decimal	28,8	Invoice fee in foreign amount, including tax.
extraFee	Decimal	28,8	Administration fee in foreign amount, including tax.
vFee	Decimal	28,8	Tax in invoice fee in foreign amount.
vFreight	Decimal	28,8	Tax in freight in foreign amount.
vExtraFee	Decimal	28,8	Tax in administration fee in foreign amount.
vFeeCode	Byte		VAT code for invoice fee.
vFreightCode	Byte		VAT code for freight.
vExtraFeeCode	Byte		VAT for administration.
account	String	6	Account receivable, refers to account.account.
difference	Numeric	28,8	Difference.
rounding	Numeric	28,8	Rounding.
status	Byte		3)
amount	Numeric	28,8	Total foreign amount for invoice.
vat	Numeric	28,8	Total tax in foreign amount for invoice.
exchange	Numeric	28,8	Exchange rate for currency.
fixedExchange	Byte		Set to 1 if fixed exchange rate should be used for payment.
username	String	30	User who created the invoice.
periodicMonths	Int		Number of periods over which the invoice should be periodically allocated.
startMonth	Int		Relative start month for periodic allocation.
tradeCode	Byte		Commercial code.
mod	String	8	Method of delivery of group type “MOD”.
tod	String	8	Terms of delivery of group type “TOD”.

extraId	String	30	Extra ID.
bankCode	String	8	Central bank code of group type “BANKCODE”.
language	String	8	Language code of group type “LANGID”.
interest	String	8	Interest procedure, refers to relinterest.id.
cashDiscount	String	8	Cash discount, refers to cashdiscount.id.
currency	String	3	Currency, refers to currency.currency.
feeAccount	String	6	Account for invoice fee.
freightAccount	String	6	Account for freight.
xFeeAccount	String	6	Account for administration fee.
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
yourOrderNo	String	30	Their order number
ourOrderNo	String	30	Our order number
group1	String	64	Group type LEDGER1
group2	String	64	Group type LEDGER2
xFreeText	String	255	Freetext on head
ourReference	String	30	Our reference
yourReference	String	30	Their reference
invoicingPeriodStart	Datetime		Invoicing period start
invoicingPeriodEnd	Datetime		Invoicing period end

Value	Comment
1	Ordinary invoice
2	Credit invoice

Value	Comment
0	Ordinary invoice
1	Credit invoice

Value	Comment
0	preliminary invoice
1	booked invoice
2	printed invoice

Get method : /api/invoice/{invoiceserie}/{invoicenumber}

Retrieves an invoice based on the invoice number and invoice serie

Inputfield	Datatype	Comment
invoiceNumber	Int	Invoice number
invoiceSerie	String	Invoice serie

Field	Datatype	Size	Comment
Head
businessUnit	String	8	Company. Refers to client.no
serie	String	8	Invoice serie
invoiceNumber	Int	12	Invoicenumber
customerID	String	40	Customer id. Refers to person.id
payer	String	12	Payer ID, refers to person.id.
payee	String	12	Payee, refers to person.id.
receiver	String	12	Receiver, refers to person.id.
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
termsOfPayment	String	8	Terms of payment
modofPayment	String	8	Mode of payment
invoiceDate	Datetime		Invoiceing date
dueDate	Datetime		Due date (Can be NULL)
invoiceType	Byte		1 – ordinary invoice, 2 – credit invoice
subType	Byte		0 – ordinary invoice, 1 – summary invoice
freeText	String	255	Freetext on head
ourreference	String	30	Our reference
yourreference	String	30	Their reference
account	String	6	Account payable
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
yourOrderNo	String	30	Their order number
ourOrderNo	String	30	Our order number
group1	String	64	Group type LEDGER1
group2	String	64	Group type LEDGER2
interest	String	8	Interest procedure
language	String	8	Language code of group type LANGID
modOfDelivery	String	8	Method of delivery of group type MOD
termsOfDelivery	String	8	Method of delivery of group type TOD
periodicMonths	Int		Number of periods over which the invoice amount should be periodically allocated
startMonth	Int		Relativ start month for periodic allocation
invoiceReference	String	128	Invoice reference
yourReferenceNumber	String	128	Reference number
invoicingPeriodStart	Datetime		Invoicing period start
invoicingPeriodEnd	Datetime		Invoicing period end
Rows
article	String	30	Articel id
freeText	String	80	Freetext for the row
account	String	6	Sales account
vatCode	byte		Vat code for the row. 0-30

vat	Decimal	28,8	Vat amount in foreign amount
quantity	Decimal	28,8	Quantity
aprice	Decimal	28,8	Price per unit
amount	Decimal	28,8	Amount in domestic currency incluing tax
forAmount	Decimal	28,8	Amount in foreign currency incluing tax
extraAmount	Decimal	28,8	Extra amount
discount	Decimal	28,8	Discount in foreign amount
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Group of group type VOUROW1
group2	String	64	Group of group type VOUROW2
group3	String	64	Group of group type VOUROW3
group4	String	64	Group of group type VOUROW4
type	Byte		1)
unit	String	8	Unit of group type UNIT

Value	Comment
0	normal row
1	total row, partial sum
2	total row
3	empty row

Get method : /api/invoice/invoicereference/{invSerie}/{invoiceNumber}

Retrieves the invoice reference based on the invoice serie and invoice number

Inputfield	Datatype	Comment
invoiceSerie	String	Invoice serie
invoiceNumber	Int	Invoice number

Field	Datatype	Size	Comment
invReference	String	128	Invoice reference
yourReferenceNumber	String	128	Reference number

InvoiceLog

Get method : /api/invoicelog/get-invoicelog-by-Id

This method will return a invoicelog

Inputfield	D	atatype	Size	Comment
invnumber	I	nt		Invoice number
invserie	string	8		Invoice serie

Field	Datatype	Size	Comment
Head
businessUnit	String	8	Company. Refers to client.no
serie	String	8	Invoice serie
invoiceNumber	Int	12	Invoicenumber
customerID	String	40	Customer id. Refers to person.id
payer	String	12	Payer ID, refers to person.id.
payee	String	12	Payee, refers to person.id.
receiver	String	12	Receiver, refers to person.id.
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
termsOfPayment	String	8	Terms of payment
modofPayment	String	8	Mode of payment
invoiceDate	Datetime		Invoiceing date
dueDate	Datetime		Due date (Can be NULL)
invoiceType	Byte		1 – ordinary invoice, 2 – credit invoice
subType	Byte		0 – ordinary invoice, 1 – summary invoice
freeText	String	255	Freetext on head
ourreference	String	30	Our reference
yourreference	String	30	Their reference
account	String	6	Account payable
currency	String	3	Currency
fee	Decimal	28,8	Invoice fee in foreign currency, including tax
freight	Decimal	28,8	Freight in foreign currency, including tax
extraFee	Decimal	28,8	Administration fee in foreign currency, including tax
vFee	Decimal	28,8	VAT in invoice fee in foreign currency
vFreight	Decimal	28,8	VAT in freight in foreign currency
vExtraFee	Decimal	28,8	VAT in administration fee in foreign currency
vFeeCode	Short		VAT code for invoice fee
vFreightCode	Short		VAT code for freight
vExtraFeeCode	Short		VAT code for administration fee
feeAccount	String	6	Account for invoice fee
freightAccount	String	6	Account for freight
xFeeAccount	String	6	Account for administration
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
yourOrderNo	String	30	Their order number
ourOrderNo	String	30	Our order number
group1	String	64	Group type LEDGER1
group2	String	64	Group type LEDGER2

interest	String	8	Interest procedure
language	String	8	Language code of group type LANGID
modOfDelivery	String	8	Method of delivery of group type MOD
termsOfDelivery	String	8	Method of delivery of group type TOD
periodicMonths	Int		Number of periods over which the invoice amount should be periodically allocated
startMonth	Int		Relativ start month for periodic allocation
invoiceReference	String	128	Invoice reference
yourReferenceNumber	String	128	Reference number
invoicingPeriodStart	Datetime		Invoicing period start
invoicingPeriodEnd	Datetime		Invoicing period end
Rows
article	String	30	Articel id
freeText	String	80	Freetext for the row
account	String	6	Sales account
vatCode	byte		Vat code for the row. 0-30
vat	Decimal	28,8	Vat amount in foreign amount
quantity	Decimal	28,8	Quantity
aprice	Decimal	28,8	Price per unit
amount	Decimal	28,8	Amount in domestic currency incluing tax
forAmount	Decimal	28,8	Amount in foreign currency incluing tax
extraAmount	Decimal	28,8	Extra amount
discount	Decimal	28,8	Discount in foreign amount
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Group of group type VOUROW1
group2	String	64	Group of group type VOUROW2
group3	String	64	Group of group type VOUROW3
group4	String	64	Group of group type VOUROW4
type	Byte		1)
unit	String	8	Unit of group type UNIT

Value	Comment
0	normal row
1	total row, partial sum
2	total row
3	empty row

Post method : /api/invoicelog/create-invoicelog

This method will create an invoicelog

Creates an invoicelog. Customer details, address, terms of payment, due date, objects and account

automatically filled from the customer register when not provided in the request. Article data (price

objects, description, account, unit), amounts and VAT are automatically calculated when not

provided. If data is provided in the request it takes precedence over auto-filled data

Inputfield	Datatype	Size	Comment
Head
businessUnit	String	8	Company. Refers to client.no
serie	String	8	Invoice serie
invoiceNumber	Int		Invoicenumber
customerID	String	12	Customer id. Refers to person.id
payer	String	12	Payer ID, refers to person.id.
payee	String	12	Payee, refers to person.id.
receiver	String	12	Receiver, refers to person.id.
address1	String	40	Address line 1
address2	String	40	Address line 2
address3	String	40	Address line 3
address4	String	40	Address line 4
address5	String	40	Address line 5
address6	String	40	Address line 6
address7	String	40	Address line 7
address8	String	40	Address line 8
termsOfPayment	String	8	Terms of payment
modofPayment	String	8	Mode of payment
invoiceDate	Datetime		Invoiceing date
dueDate	Datetime		Due date (Can be NULL)
invoiceType	Byte		1 – ordinary invoice, 2 – credit invoice
subType	Byte		0 – ordinary invoice, 1 – summary invoice
freeText	String	255	Freetext on head
ourreference	String	30	Our reference
yourreference	String	30	Their reference
account	String	6	Account payable
currency	String	3	Currency
fee	Decimal	28,8	Invoice fee in foreign currency, including tax
freight	Decimal	28,8	Freight in foreign currency, including tax
extraFee	Decimal	28,8	Administration fee in foreign currency, including tax
vFee	Decimal	28,8	VAT in invoice fee in foreign currency
vFreight	Decimal	28,8	VAT in freight in foreign currency
vExtraFee	Decimal	28,8	VAT in administration fee in foreign currency
vFeeCode	Short		VAT code for invoice fee
vFreightCode	Short		VAT code for freight
vExtraFeeCode	Short		VAT code for administration fee
feeAccount	String	6	Account for invoice fee
freightAccount	String	6	Account for freight
xFeeAccount	String	6	Account for administration
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
yourOrderNo	String	30	Their order number
ourOrderNo	String	30	Our order number
group1	String	64	Group type LEDGER1
group2	String	64	Group type LEDGER2

interest	String	8	Interest procedure
language	String	8	Language code of group type LANGID
modOfDelivery	String	8	Method of delivery of group type MOD
termsOfDelivery	String	8	Method of delivery of group type TOD
periodicMonths	Int		Number of periods over which the invoice amount should be periodically allocated
startMonth	Int		Relativ start month for periodic allocation
transfer	Bool		Transfer from log to invoice after creation
checkRule	Byte		Check rules during transfer
invoiceReference	String	128	Invoice reference
yourReferenceNumber	String	128	Reference number
deleteAfterTransfer	Bool		Delete invoicelog after transfer if log is transferred ok
invoicingPeriodStart	Datetime		Invoicing period start
invoicingPeriodEnd	Datetime		Invoicing period end
extraId	String	30	Extra ID
Rows
article	String	20	Articel id
freeText	String	80	Freetext for the row
account	String	6	Sales account
vatCode	Byte		Vat code for the row. 0-30
vat	Decimal	28,8	Vat amount in foreign amount
quantity	Decimal	28,8	Quantity
aprice	Decimal	28,8	Price per unit
amount	Decimal	28,8	Amount in domestic currency incluing tax
forAmount	Decimal	28,8	Amount in foreign currency incluing tax
extraAmount	Decimal	28,8	Extra amount
discount	Decimal	28,8	Discount in foreign amount
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Group of group type VOUROW1
group2	String	64	Group of group type VOUROW2
group3	String	64	Group of group type VOUROW3
group4	String	64	Group of group type VOUROW4
type	Byte		1)
unit	string	8	Unit of group type UNIT

Value	Comment
0	normal row
1	total row, partial sum
2	total row
3	empty row

Field	Datatype		Comment
invoiceNumber	Int	I	nvoice number of created invoice
errorNo	Int	Error number
errorDescription	String	Error message

Post method : /api/invoicelog/create-invoicelog-customer-details

This method will create an invoicelog. Customer details will be copied to the invoicelog

Inputfield	Datatype	Size	Comment
Head
businessUnit	String	8	Company. Refers to client.no
serie	String	8	Invoice serie
invoiceNumber	Int		Invoicenumber
customerID	String	12	Customer id. Refers to person.id
payer	String	12	Payer ID, refers to person.id.
payee	String	12	Payee, refers to person.id.
receiver	String	12	Receiver, refers to person.id.
invoiceDate	Datetime		Invoiceing date
invoiceType	Byte		1 – ordinary invoice, 2 – credit invoice
freeText	String	255	Freetext on head
ourreference	String	30	Our reference
yourreference	String	30	Their reference
currency	String	3	Currency
transferInvoiceLog	Bool		Transfer from log to invoice after creation
invoiceReference	String	128	Invoice reference
yourReferenceNumber	String	128	Reference number
deleteAfterTransfer	Bool		True – Delete log after successful transfer, False – keep log after transfer
invoicingPeriodStart	Datetime		Invoicing period start
invoicingPeriodEnd	Datetime		Invoicing period end
Rows
freeText	String	80	Freetext for the row
account	String	6	Sales account
vatCode	Byte		Vat code for the row. 0-30
vat	Decimal	28,8	Vat amount in foreign amount
quantity	Decimal	28,8	Quantity
aprice	Decimal	28,8	Price per unit
amount	Decimal	28,8	Amount in domestic currency incluing tax
forAmount	Decimal	28,8	Amount in foreign currency incluing tax
article	String	20	Id of article
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
type	Byte		1)
group1	String	64	Group of group type VOUROW1
group2	String	64	Group of group type VOUROW2
group3	String	64	Group of group type VOUROW3
group4	String	64	Group of group type VOUROW4
discount	Decimal	28,8	Discount in foreign amount.
unit	String	8	Unit of group type ”UNIT”

Value	Comment
0	normal row
1	total row, partial sum
2	total row
3	empty row

Return values

Field	Datatype	C	omment
invoiceNumber	Int	I	nvoice number of created invoice

errorNo	Int	Error number
errorDescription	String	Error message

Ledger

Get method : /api/ledger/get-supplierledger

This method will return a supplier ledger

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie
invno	Int	Ledger number

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Voucher serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number
extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6

o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger
interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Value	Comment
0	interest can be calculated for the ledger
1	interest can not be calculated for the ledger

Get method : /api/ledger/get-salesledger

This method will return a sales ledger

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie
invno I	nt	Invoice number

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Voucher serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decmal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number
extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger

interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Value	Comment
0	interest can be calculated for the ledger
1	interest can not be calculated for the ledger

Get method : /api/ledger/get-ledgers

This method will return a list of ledgers

Inputfield	Datatype	Comment
lastUpdatedDate	Datetime	1)
includePreliminary	Bool
page	int	0 is first page

Where voucher.voucounter >= lastUpdatedDate

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Voucher serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decmal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number
extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4

o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger
interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Value	Comment
0	interest can be calculated for the ledger
1	interest can not be calculated for the ledger

Get method : /api/ledger/get-ledgers-by-dates

This method will return a list of ledgers

Inputfield	Datatype	Comment
bookingDateFrom	Datetime	Accounting date from. 1)
bookingDateTo	datetime	Accounting date to. 1)
includePreliminary	Bool	Flag to include preliminary ledgers
onlyUnpaid	Bool	Flag to include only unpaid ledgers
page	int	0 is first page

Where ledger.bookdate between bookingDateFrom and bookingDateTo

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Voucher serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decmal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number
extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2

o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger
interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Value	Comment
0	interest can be calculated for the ledger
1	interest can not be calculated for the ledger

Get method : /api/ledger/get-nextinvoicenumber

This method returns next invoicenumber

Inputfield	Datatype	Size	Comment
enumerator	String	8	Invoice serie
invoicedate	Datetime		Invoiceing date
ledgertype	Short		-1 – supplier invoices, 1 – customer invoices

Field	Datatype	Comment
	Int	Next invoice number

Get method : /api/ledger/get-ledgerlog-by-Id

This method returns a ledgerlog

Inputfield	Datatype	Size	Comment
invno	Int		Invoice number
enumerator	string	8	Ledger serie

Field	Datatype	Size	Comment
businessUnit	String	8	Company
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
type	Int		Ledger type. See method /api/invoice/get-types
itype	Int		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Int		Sequential number. The header record is always 0. Sub records have 1-255
org	String	30	Original invoice number
extraid	String	30	Extra id
code	Int		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment
			proposal
xlevel	Int		Reminder level for sales ledgers
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
currency	String	3	Currency
fixedexchange	Int		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
vatcode	Int		Vat code
discount	String	8	Cash discount
account	String	6	Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
interest	String	8	Interest procedure
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
vouno	Int		Voucher number
voucherSerie	String	8	Voucher serie
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
note	String	255	Internal note for ledger
year	Int		Year
usedcd	Decimal	28,8	Used cash discount
ocr	String	100	Ocr number

Post method : /api/ledgerlog/customer

This method creates a customer ledgerlog

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
businessUnit	String	8	Company
person	String	12	Customer. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
type	Int		Ledger type. See method /api/invoice/get-types
itype	Int		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Int		Sequential number. The header record is always 0. Sub records have 1-255
org	String	30	Original invoice number
extraid	String	30	Extra id
code	Int		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Int		Reminder level for sales ledgers
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
currency	String	3	Currency
fixedexchange	Int		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
vatcode	Int		Vat code
discount	String	8	Cash discount
account	String	6	Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
interest	String	8	Interest procedure
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
vouno	Int		Voucher number
voucherSerie	String	8	Voucher serie
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
note	String	255	Internal note for ledger

year	Int		Year
usedcd	Decimal		Used cash discount
ocr	String	100	Ocr number
transferLog	bool		False – no automatic transfer, true – automatic transfer
deleteaftertransfer	bool		False – No delete, true – delete

Field	Datatype	Comment
ledgerSerie	String	Ledger serie
invno	Int	Invoice number
logno	Int	Log number for ledger. Refers to voulog.logno
message	String

Post method : /api/ledgerlog/supplier

This method creates a supplier ledgerlog

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
businessUnit	String	8	Company
person	String	12	Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
type	Int		Ledger type. See method /api/invoice/get-types
itype	Int		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Int		Sequential number. The header record is always 0. Sub records have 1-255
org	String	30	Original invoice number
extraid	String	30	Extra id
code	Int		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Int		Reminder level for sales ledgers
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
currency	String	3	Currency
fixedexchange	Int		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
vatcode	Int		Vat code
discount	String	8	Cash discount
account	String	6	Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
vouno	Int		Voucher number
voucherSerie	String	8	Voucher serie
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int	8	Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE

note	String	255	Internal note for ledger
year	Int		Year
usedcd	Decimal	28,8	Used cash discount
ocr	String	100	Ocr number
transferLog	bool		False – no automatic transfer, true – automatic transfer
deleteaftertransfer	bool		False – No delete, True = delete after transfer

Field	Datatype	Comment
ledgerSerie	String	Ledger serie
invno	Int	Invoice number
logno	Int	Log number for ledger. Refers to voulog.logno
message	String

Post method : /api/ledgerlog-withvoucher/customer

This method creates a customer ledgerlog with voucherlog

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
Ledgerlog:
businessUnit	String	8	Company
person	String	12	Customer. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
type	Int		Ledger type. See method /api/invoice/get-types
itype	Int		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Int		Sequential number. The header record is always 0. Sub records have 1-255
org	String	30	Original invoice number
extraid	String	30	Extra id
code	Int		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Int		Reminder level for sales ledgers
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
currency	String	3	Currency
fixedexchange	Int		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
vatcode	Int		Vat code
discount	String	8	Cash discount
account	String	6	Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
interest	String	8	Interest procedure
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
vouno	Int		Voucher number
voucherSerie	String	8	Voucher serie
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int	8	Commercial code
payform	String	8	Pay form of group type PAYFORM

feecode	String	8	Fee code of group type FEECODE
note	String	255	Internal note for ledger
year	Int		Year
usedcd	Decimal	28,8	Used cash discount
ocr	String	100	Ocr number
transferLog	bool		False – no automatic transfer, true – automatic transfer
deleteaftertransfer	bool		False – No delete, True = delete after transfer
VoucherLog:
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Int		Ledger type. See method /api/invoice/get-types
enumerator	String	8	Invoice serie
invno	Int		Invoice number
voucherDate	Datetime		Accounting date
userid	String	255	User creating the voucher
userGroup1	String	128	Group of type VOUCHER1
userGroup2	String	128	Group of type VOUCHER2
freeText	String	80	Free text
transferLog	Bool		True – transferlog, false – do not transfer log
checkRule	Int		Check business rules on transfer
Rows:
account	String	6	Account
amount	Decimal		Amount
foramount	Decimal		Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Quantity
freeText	String	80	Free text on row
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
vatCode	Int		Vat code

Field	Datatype	Size	Comment
ledgerSerie	String	8	Ledger serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
voucherNumber	Int		Vouncher number
logno	Int		Voucher logno
message	String

Post method : /api/ledgerlog-withvoucher/supplier

This method creates a supplier ledgerlog with voucherlog

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
Ledgerlog:
businessUnit	String	8	Company
person	String	12	Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
type	Int		Ledger type. See method /api/invoice/get-types
itype	Int		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Int		Sequential number. The header record is always 0. Sub records have 1-255
org	String	30	Original invoice number
extraid	String	30	Extra id
code	Int		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Int		Reminder level for sales ledgers
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
currency	String	3	Currency
fixedexchange	Int		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
vatcode	Int		Vat code
discount	String	8	Cash discount
account	String	6	Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
vouno	Int		Voucher number
voucherSerie	String	8	Voucher serie
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int	8	Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE

note	String	255	Internal note for ledger
year	Int		Year
usedcd	Decimal	28,8	Used cash discount
ocr	String	100	Ocr number
transferLog	bool		False – no automatic transfer, true – automatic transfer
deleteaftertransfer	bool		False – No delete, True = delete after transfer
VoucherLog:
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Int		Ledger type. See method /api/invoice/get-types
enumerator	String	8	Invoice serie
invno	Int		Invoice number
voucherDate	Datetime		Accounting date
userid	String	255	User creating the voucher
userGroup1	String	128	Group of type VOUCHER1
userGroup2	String	128	Group of type VOUCHER2
freeText	String	80	Free text
transferLog	Bool		True – transferlog, false – do not transfer log
checkRule	Int		Check business rules on transfer
Rows:
account	String	6	Account
amount	Decimal		Amount
foramount	Decimal		Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Quantity
freeText	String	80	Free text on row
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
vatCode	Int		Vat code

Field	Datatype	Size	Comment
ledgerSerie	String	8	Ledger serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
voucherNumber	Int		Vouncher number
logno	Int		Voucher logno
message	String

Post method : /api/ledger/create-supplier-ledger

Creates a supplier ledger with the default (autogenerated) accounting data, creates period

allocations for rows and preliminary fixed assets if a fixed asset is used. For changing an existing

supplier ledger Invno parameter must have a greater than 0 value

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
vatCode	Int		Vat code
invoiceType	Int		Ledger type. See method /api/invoice/get-types
amount	Decimal	28,8	Amount
foreignAmount	Decimal	28,8	Foreign amount
currency	String	3	Currency
extraid	String	30	Extra ID
cid	String	8	Company
personId	String	12	Supplier id
contraAccount	String	6	Account
bookDate	Datetime		Accounting date
invoiceDate	Datetime		Invoice date
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
doPeriodAllocation	Bool		True – create period allocation, false – do not create period allocation
periodAllocationStartDate	Datetime		Period allocation start date
periodAllocationEndDate	Datetime		Period allocation end date
periodAllocationAccount	String	6	Periodic allocation account
definitiveBooked	Bool		True – invoice is definitive, false – invoice is arrival booked

Field	Datatype	Size	Comment
success	Bool		True – successful, false – not successful
result:
ledgerSerie	String	8	Invoice serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
voucherNumber	Int		Voucher number
reversedVoucherSerie	String	8	Reversed voucher serie
reversedVoucherNumber	Int		Reversed voucher number
preliminaryAsset	Bool		True – preliminary asset was created, false - preliminary asset was not created
periodicAllocation	Int		Periodic Allocation

Post method : /api/ledger/create-supplier-ledger-with-voucherrows

Creates a supplier ledger with the provided accounting data (check the parameters- Voucher rows)

creates period allocations for rows and preliminary fixed assets if a fixed asset is used. For changing

an existing supplier ledger Invno parameter must have a greater than 0 value

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
vatCode	Byte		Vat code
vatAmount	Decimal	28,8	Vat amount
originalInvoiceNumber	String	30	Original invoice number
ocrNumber	String	100	Ocr number
invoiceType	Short		Ledger type. See method /api/invoice/get-types
Amount	Decimal	28,8	Amount
foreignAmount	Decimal	28,8	Foreign amount
Currency	String	3	Currency
extraid	String	30	Extra ID
cid	String	8	Company
personId	String	12	Supplier id
contraAccount	String	6	Account
bookDate	Datetime		Accounting date
invoiceDate	Datetime		Invoice date
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
definitiveBooked	Bool		True – invoice is definitive, false – invoice is arrival booked
dueDate	Datetime		Due date
group2	String	64	Free group of group type “LEDGER2”
group1	String	64	Free group of group type “LEDGER1”
note	String	255	Internal note for ledger
freeText	String	80	Freetext
voucherRows
account	String	6	Account
amount	Decimal		Amount
foramount	Decimal		Foreign amount
currency	String	3	Currency
number	Decimal		Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
doPeriodAllocation	Bool		True – create period allocation, false – do not create period allocation

periodAllocationStartDate	Datetime		Period allocation start date
periodAllocationEndDate	Datetime		Period allocation end date
periodAllocationAccount	String	6	Periodic allocation account

Field	Datatype	Size	Comment
success	Bool		True – successful, false – not successful
result:
ledgerSerie	String	8	Invoice serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
voucherNumber	Int		Voucher number
reversedVoucherSerie	String	8	Reversed voucher serie
reversedVoucherNumber	Int		Reversed voucher number
preliminaryAsset	Bool		True – preliminary asset was created, false - preliminary asset was not created
periodicAllocation	Int		Periodic Allocation

Post method : /api/ledger/create-customer-ledger-with-voucherrows

Creates a customer ledger with the provided accounting data (check the parameters- Voucher rows)

creates period allocations for rows and preliminary fixed assets if a fixed asset is used. For changing

an existing supplier ledger Invno parameter must have a greater than 0 value

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
vatCode	Byte		Vat code
vatAmount	Decimal	28,8	Vat amount
originalInvoiceNumber	String	30	Original invoice number
ocrNumber	String	100	Ocr number
invoiceType	Short		Ledger type. See method /api/invoice/get-types
Amount	Decimal	28,8	Amount
foreignAmount	Decimal	28,8	Foreign amount
Currency	String	3	Currency
cid	String	8	Company
personId	String	12	Customer id
contraAccount	String	6	Account
bookDate	Datetime		Accounting date
invoiceDate	Datetime		Invoice date
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
definitiveBooked	Bool		True – invoice is definitive, false – invoice is arrival booked
dueDate	Datetime		Due date
interest	String	8	Interest procedure, refers to relinterest.id.
group1	String	64	Free group of group type “LEDGER2”
group2	String	64	Free group of group type “LEDGER1”
note	String	255	Internal note for ledger
freeText	String	80	Freetext
voucherRows
account	String	6	Account
amount	Decimal		Amount
foramount	Decimal		Foreign amount
currency	String	3	Currency
number	Decimal		Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
doPeriodAllocation	Bool		True – create period allocation, false – do not create period allocation

periodAllocationStartDate	Datetime		Period allocation start date
periodAllocationEndDate	Datetime		Period allocation end date
periodAllocationAccount	String	6	Periodic allocation account

Field	Datatype	Size	Comment
success	Bool		True – successful, false – not successful
result:
ledgerSerie	String	8	Invoice serie
invno	Int		Invoice number
voucherSerie	String	8	Voucher serie
voucherNumber	Int		Voucher number
periodicAllocation	Int		Periodic Allocation

Post method : /api/ledger/create-customer-ledger

Creates a customer ledger with the default (autogenerated) accounting data

Example of calculation of amounts

Currency	Amount	Foramount	Comment
EUR	12	0	Foramount will be calculated based on currency EUR
EUR	0	12	Amount will be calculated based on currency EUR
null	12	0	Foramount will be set as amount. No calculation
null	0	12	Amount will be set as amount. No calculation

Inputfield	Datatype	Size	Comment
LedgerSerie	String	8	Ledger serie
Invno	Int		Invoice number
VoucherSerie	String	8	Voucher serie
VatCode	Byte		Vat code
Vataccount			Vat account
Amount	Decimal	28,8	Vat amount
ForeignAmount	Decimal	28,8	Foreign amount
Currency	String	3	Currency
Cid	String	8	Company
Customerid	String	12	Customer id
IncomeAccount	String	6	Account
CustomerAccount			Account
BookDate	Datetime		Accounting date
InvoiceDate	Datetime		Invoice date
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
interest	String	8	Interest procedure, refers to relinterest.id
note	String	255	Internal note for ledger
freeText	String	80	Free text
LedgerRow
amount	Decimal		Amount
foramount	Decimal		Foreign amount
VatAccount	String	6	Account
VatCode	Byte		Vat code

Field	Datatype	Size	Comment
LedgerSerie	String	8	Ledger serie
Invno	Int		Invoice number
VoucherSerie	String	8	Voucher serie
VoucherNumber	Int		Voucher number
PeriodicAllocation	Int

Post method : /api/ledger/block-supplier-ledger

This method will block a ledger record for payments

Inputfield	Datatype	Size	Comment
InvoiceSerie	String	8	Ledger serie
InvoiceNumber	Int	Invoice number
Blocked	Bool	Blocked = true; Not blocked = false

Get method : /api/ledger/get-paid-ledgers

This method returns a list of lerdgers

Inputfield	Datatype	Comment
payDateStart	Datetime	Gets ledgers greater then or equal to startdate. 1)

Where ledger.paydate >= payDateStart and ledger.seq = 0

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Invoice serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number
extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6

o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger
interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Get method : /api/ledger/get-paid-ledgers-daterange

This method returns a list of ledgers

Inputfield	Datatype	Comment
payDateStart	Datetime	Startdate. 1)
payDateEnd	Datetime	Enddate. 1)
ledgerType	PersonEnumType	2)

Where ledger.paydate >= paydateStart and ledger.paydate <= payDateEnd and ledger.seq = 0

Value	Comment
-1	Supplier
1	Customer
3	FixedAsset

Field	Datatype	Size	Comment
vatcode	Byte		Vat code
serie	String	8	Invoice serie
ocr	String	100	Ocr number
year	Short		Year
remfee	Decimal	28,8	Reminder fee for ledger
account	String		Account recivable for sales ledger / account payable for supplier ledgers
differens	Decimal	28,8	Difference
usedcd	Decimal	28,8	Used cash discount
status	Byte		0 – open, 1 – printed, 2 – ready for autopayment
code	Byte		0 – normal ledger, 1 – arrival registered, 2 – to be reported back, 3 – payment proposal
xlevel	Byte		Reminder level for sales ledgers
blocked	Byte		Blocked for reminders / payments
bookdate	Datetime		Accounting date
invdate	Datetime		Invoicing date
type	Short		Ledger type. See method /api/invoice/get-types
itype	Short		Internal type. -1 for supplier ledgers / 1 for customer ledgers
enumerator	String	8	Ledger serie
invno	Int		Invoice number
seq	Byte		Sequential number. The header record is always 0. Sub records have 1-255
fixedexchange	Byte		0 – variable exchange rate, 1 – fixed exchange rate
amount	Decimal	28,8	Amount
interestblocked	Byte		1)
person	String	12	Customer / Supplier. Must exist in person table
payer	String	12	Payer
payee	String	12	Payee
receive	String	12	Invoice recipient
mop	String	8	Mode of payment
rop	String	8	Payee mode of payment
group1	String	64	Free group of group type LEDGER1
group2	String	64	Free group of group type LEDGER2
freetext	String	80	Free text
approval1	String	8	First approval. Refers to signature
approval2	String	8	Second approval. Refers to signature
logno	Int		Log number for ledger. Refers to voulog.logno
foramount	Decimal	28,8	Foreign amount
vat	Decimal	28,8	Vat amount
org	String	30	Original invoice number

extraid	String	30	Extra id
duedate	Datetime		Due date
interestduedate	Datetime		Interest due date
paydate	Datetime		Final payment date
lastinterest	Datetime		Last interest calculation date
lastinternal	Datetime		Last internal interest calculation date
claimdate	Datetime		Last reminders booking date for sales ledgers / arrival date for supplier ledgers
currency	String	3	Currency
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
note	String	255	Internal note for ledger
interest	String	8	Interest procedure
vouno	Int		Voucher number
bankcode	String	8	Central bank code of group type BANKCODE
tradecode	Int		Commercial code
payform	String	8	Pay form of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
discount	String	8	Cash discount
cid	String	8	Company

Delete method : /api/ledger/delete-ledger

This method deletes a ledger based on serie, invoicenumber and ledgertype

Inputfield	Datatype	Size	Comment
serie	String	8	Ledger serie.
invno	Int	Invoice number
ledgerType	PersonEnumType	1)
accountingDate	DateTime	Accountingdate

Value	Comment
-1	Supplier
1	Customer
3	FixedAsset

Field	Datatype	Comment
success	Bool	true – succesful, false – not succesful
result	Int
errorMessage	String	Errormessage

Get method : /api/ledger/supplier-ledgers-by-dates

This method returns a list of supplier ledgers based on a date range

Inputfield	Datatype	Comment
fromDate	Datetime	Startdate. 1)
toDate	Datetime	Enddate. 1)
page	Int	Page to fetch.

Field	Datatype	Size	Comment
invoiceNumber	Int		Invoice number
invoiceSerie	String		Ledger serie
bookDate	Datetime		Accounting date
lastChangedDate	Datetime		Voucounter on conneted voucher
type	Short		2)
amount	Numeric	28,8	Amount
foreignAmount	Numeric	28,8	Foreign amount
vatAmount	Numeric	28,8	VAT amount
currency	String	3	Currency
supplierId	String	12	Supplier Id
voucherNumber	Int		Voucher number
voucherRows:
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Numeric	28,8	Amount
foramount	Numeric	28,8	Foreign amount
currency	String	3	Currency
number	Numeric	28,8	Number
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
altered	Byte		0 – no change, 1 – added row, 2 – deleted row
bookDate	Datetime		Accounting date
serie	String		Voucher serie
rowNo	Int		Row number
year	Byte		Year number
period	Byte		Period number
resaccount	String	6	Profit/loss account if one of the objects is balanced
extraAmount	Numeric	28,8	Extra amount
vatCode	Byte		VAT code
crType	Byte		3)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmountbaseAmount	Numeric	28,8	Amount in alternative currency
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Where ledger.bookdate between fromDate and toDate and ledger.seq = 0 and ledger.itype = -1

type	Description
-1	Invoice
-2	Credit
-3	On account
-4	Advance
-10	Final payment
-11	Partial payment
-12	Difference
-13	Cash discount
-14	Matching
-15	Currency profit
-16	Currency loss

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

Post method : /api/ledger/register-customer-payment

This method creates a customer payment

Inputfield	Datatype	Size	Comment
serie	String	8	Ledgerserie
invoiceNumber	Int		Invoicenumber
amount	Numeric	28,8	Amount
foramount	Numeric	28,8	Foreign amount
fee	Numeric	28,8	Invoice fee in foreign amount, including tax
bookdate	DateTime		Accounting date
modeOfPayment	String	8	Mod of payment
iban	String	34	International Bank Account Number
currency	String	3	Currency

Field	Datatype	Size	Comment
voucherSerie	String		Voucher serie
voucherNumber	Int		Voucher number
voucherRows:
account	String	6	Account
currency	String	3	Currency
amount	Decimal	28,8	Amount
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
Ledgers:
type	Int		1)
currency	String	3	Currency
invoiceNumber	Int		Invoicenumber
invoiceSerrie	String		Ledgerserie
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount

Value	Comment
1	invoice, customer invoice
2	credit, customer invoice
3	interest invoice, customer invoice
4	interest credit, customer invoice
5	on account, customer invoice
6	advance, customer invoice
10	final payment, customer invoice
11	partial payment, customer invoice
12	difference, customer invoice
13	cash discount, customer invoice
14	fee, customer invoice
15	matching, customer invoice
16	currency profit, customer invoice
17	currency loss, customer invoice

Post method : /api/ledger/register-supplier-payment

This method creates a supplier payment

Inputfield	Datatype	Size	Comment
serie	String	8	Ledgerserie
invoiceNumber	Int		Invoicenumber
amount	Numeric	28,8	Amount
foramount	Numeric	28,8	Foreign amount
fee	Numeric	28,8	Invoice fee in foreign amount, including tax
bookdate	DateTime		Accounting date
modeOfPayment	String	8	Mod of payment
iban	String	34	International Bank Account Number
currency	String	3	Currency
sequence	Int		Sequential number. The header record always has number 0, sub-records have numbers in range: 1 – 255.

Field	Datatype	Size	Comment
voucherSerie	String		Voucher serie
voucherNumber	Int		Voucher number
voucherRows:
account	String	6	Account
currency	String	3	Currency
amount	Decimal	28,8	Amount
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
Ledgers:
type	Int		1)
currency	String	3	Currency
invoiceNumber	Int		Invoicenumber
invoiceSerrie	String		Ledgerserie
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount

Value	Comment
-1	Invoice
-2	Credit
-3	On account
-4	Advance
-10	Final payment
-11	Partial payment
-12	Difference
-13	Cash discount
-14	Matching
-15	Currency profit
-16	Currency loss

LedgerSerie

Get method : /api/ledgerserie

This method will return a list of all ledger series

Field	Datatype	Size	Comment
type	Short		1)
nextNo	Int		Next number
newNo	Int		New number after the swap date
enumeratorId	String	8	Id
locked	Byte		2)
freeUse	Byte		3)
lockedBy	String	255	User who locked the serie
cid	String	8	Business unit that uses the serie. NULL in case the serie is used by all business units
description	String	30	Description
swapDate	Datetime		Date when to switch to new number

Value	Comment
1	for sales ledgers and invoicing
-1	for supplier ledgers

Value	Comment
0	enumeration serie is not locked
1	enumeration serie is locked

Value	Comment
0	only one user can use the serie
1	many users can use the serie

Get method : /api/ledgerserie/{businessUnitId}

This method will return a list of ledger series filtered by business unit

Inputfield	Datatype	Size	Comment
businessUnitId	String	8	Companyid

Field	Datatype	Size	Comment
type	Short		1)
nextNo	Int		Next number
newNo	Int		New number after the swap date
enumeratorId	String	8	Id
locked	Byte		2)
freeUse	Byte		3)
lockedBy	String	255	User who locked the serie
cid	String	8	Business unit that uses the serie. NULL in case the serie is used by all business units
description	String	30	Description
swapDate	Datetime		Date when to switch to new number

Value	Comment
1	for sales ledgers and invoicing
-1	for supplier ledgers

Value	Comment
0	enumeration serie is not locked
1	enumeration serie is locked

Value	Comment
0	only one user can use the serie
1	many users can use the serie

Misc

Get method : /api/misc/get-labels

This method will return a list of labels. Used for accountclasses and accountgroups

Field	Datatype	Size	Comment
labelNo	String	4	Label id
labelCaption	String	80	Name

Get method : /api/misc/get-imsettings

This method will return a list of DCE settings

Field	Datatype	S	ize	C	omment
id	String	2	0	S	ettings id
value	String 2		00 S		etting

Get method : /api/misc/get-controlsettings

This method will return Control settings

Field	Datatype	Size	Comment
defaultCompany	String	8	Default company
baseCurrency	String	3	Domestic currency
countryCode	String	8	Country code
amountPrecision	Byte		Number of digits after the amounts
exchangePrecision	Byte		Number of digits after the exchange rates
numberPrecision	Byte		Number of digits after the numbers
customerDifference	Numeric	28,8	Minimum difference in amounts for customer invoice to be considered fully
			paid
supplierDifference	Numeric	28,8	Minimum difference in amounts for supplier ledger to be considered fully paid

Get method : /api/misc/get-coderelations

This method returns a list of coderelations

Field	D	atatype	Size	Comment
cid	St	ring	8	The company the rule applies to
account	String		6	Rule applies to this selection of accounts
o1	String		4096	Rule applies to this selection of objects of type 1
o2	String		4096	Rule applies to this selection of objects of type 2
o3	String		4096	Rule applies to this selection of objects of type 3
o4	String		4096	Rule applies to this selection of objects of type 4
o5	String		4096	Rule applies to this selection of objects of type 5
o6	String		4096	Rule applies to this selection of objects of type 6
o7	String		4096	Rule applies to this selection of objects of type 7
o8	String		4096	Rule applies to this selection of objects of type 8
locked	Byte			0 – allowed combination, 1 – locked combination
fromdate	Datetime			Rule applies from this date
todate	Datetime			Rule applies up to this date
errortext	String		255	Message to be shown when the locked combination is invoked

Get method : /api/misc/get-calendar

This method returns a list of calendar items. The calendar is used to list the days that can’t be used as

banking days

Field	Datatype	Size	Comment
year	Short		Calendar year
month	Byte		Mounth
Day	Short		Day
Name	String	100	Name of the holiday

Get method : /api/tenant/abbreviation

This method returns the tenant abbreviation

Field	Datatype	Size	Comment
	String		Tenant abbreviation

Note

Get method : /api/note/supplier/{supplierid}

This method returns a list of notes for the specified supplierid

Inputfield	Datatype	Size	Comment
supplierid	String	12	Supplier id

Field	Datatype	Size	Comment
notetype	Short	20	Type of note. Refers to user groups of group type “NOTES”
noteobject	String	15	Object to which the note belongs
notename	String	8	Note’s name
notedate	Datetime		Date of note
note	String	max	Note text

Post method : /api/note/supplier/{supplierid}

This method creates a note for the specified supplierid

Inputfield	Datatype	Size	Comment
supplierid	String	12	Supplier id

Request body

Delete method : /api/note/{noteid}/supplier/{supplierid}

This method deletes a note for the specified supplierid

Inputfield	Datatype	Size	Comment
supplierid	String	12	Supplier id
noteid	String	8	Note’s name

Object

Get method : /api/object/get-objects

This method returns a list of objects

Inputfield	Datatype	Comment
no	Int	Object type. 1 – 8
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
no	Byte		Object type. 1 – 8
name	String	30	Object name
objectId	String	64	Object id
businessUnit	String	8	Company. Can be null
userGroup1	String	64	Free group of group type OBJECT{no}-1
userGroup2	String	64	Free group of group type OBJECT{no}-2
userGroup3	String	64	Free group of group type OBJECT{no}-3
userGroup4	String	64	Free group of group type OBJECT{no}-4
userGroup5	String	64	Free group of group type OBJECT{no}-5
userGroup6	String	64	Free group of group type OBJECT{no}-6
userGroup7	String	64	Free group of group type OBJECT{no}-7
userGroup8	String	64	Free group of group type OBJECT{no}-8
userGroup9	String	64	Free group of group type OBJECT{no}-9
userGroup10	String	64	Free group of group type OBJECT{no}-10
userGroup11	String	64	Free group of group type OBJECT{no}-11
userGroup12	String	64	Free group of group type OBJECT{no}-12
userGroup13	String	64	Free group of group type OBJECT{no}-13
userGroup14	String	64	Free group of group type OBJECT{no}-14
userGroup15	String	64	Free group of group type OBJECT{no}-15
userGroup16	String	64	Free group of group type OBJECT{no}-16
userGroup17	String	64	Free group of group type OBJECT{no}-17
userGroup18	String	64	Free group of group type OBJECT{no}-18
userGroup19	String	64	Free group of group type OBJECT{no}-19
userGroup20	String	64	Free group of group type OBJECT{no}-20
o1	String	64	Standard object of type 1
o2	String	64	Standard object of type 2
o3	String	64	Standard object of type 3
o4	String	64	Standard object of type 4
o5	String	64	Standard object of type 5
o6	String	64	Standard object of type 6
o7	String	64	Standard object of type 7
o8	String	64	Standard object of type 8
objectBegin	Datetime		Valid from date
objectEnd	Datetime		Valid to date
balanced	Byte		0 – object is not balanced, 1 – object is balanced
balancedDirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced
action	Datetime		Change date
o1Relation	Int		1)
o2Relation	Int		1)
o3Relation	Int		1)
o4Relation	Int		1)
o5Relation	Int		1)
o6Relation	Int		1)
o7Relation	Int		1)
o8Relation	int		1)
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

1) 119

Value	Comment
0	0 – object can never be used with objects of type 1.
1	1 – object can be used with objects of type 1.
2	2 – object must be used with objects of type 1.

Get method : /api/object/get-object-by-id

This method returns an object

Inputfield	Datatype	Size	Comment
no	Int		Object id
objectName	String	30	Object name

Field	Datatype	Size	Comment
no	Int		Object type. 1 – 8
name	String	30	Object name
objectId	String	64	Object id
businessUnit	String	8	Company. Can be null
userGroup1	String	64	Free group of group type OBJECT{no}-1
userGroup2	String	64	Free group of group type OBJECT{no}-2
userGroup3	String	64	Free group of group type OBJECT{no}-3
userGroup4	String	64	Free group of group type OBJECT{no}-4
userGroup5	String	64	Free group of group type OBJECT{no}-5
userGroup6	String	64	Free group of group type OBJECT{no}-6
userGroup7	String	64	Free group of group type OBJECT{no}-7
userGroup8	String	64	Free group of group type OBJECT{no}-8
userGroup9	String	64	Free group of group type OBJECT{no}-9
userGroup10	String	64	Free group of group type OBJECT{no}-10
userGroup11	String	64	Free group of group type OBJECT{no}-11
userGroup12	String	64	Free group of group type OBJECT{no}-12
userGroup13	String	64	Free group of group type OBJECT{no}-13
userGroup14	String	64	Free group of group type OBJECT{no}-14
userGroup15	String	64	Free group of group type OBJECT{no}-15
userGroup16	String	64	Free group of group type OBJECT{no}-16
userGroup17	String	64	Free group of group type OBJECT{no}-17
userGroup18	String	64	Free group of group type OBJECT{no}-18
userGroup19	String	64	Free group of group type OBJECT{no}-19
userGroup20	String	64	Free group of group type OBJECT{no}-20
o1	String	64	Standard object of type 1
o2	String	64	Standard object of type 2
o3	String	64	Standard object of type 3
o4	String	64	Standard object of type 4
o5	String	64	Standard object of type 5
o6	String	64	Standard object of type 6
o7	String	64	Standard object of type 7
o8	String	64	Standard object of type 8
objectBegin	Datetime		Valid from date
objectEnd	Datetime		Valid to date
balanced	Byte		0 – object is not balanced, 1 – object is balanced
balancedDirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced
action	Datetime		Change date
o1Relation	Int		1)
o2Relation	Int		1)
o3Relation	Int		1)
o4Relation	Int		1)
o5Relation	Int		1)
o6Relation	Int		1)
o7Relation	Int		1)
o8Relation	int		1)

Value	Comment
0	0 – object can never be used with objects of type 1.
1	1 – object can be used with objects of type 1.
2	2 – object must be used with objects of type 1.

Get method : /api/object/get-types

This method returns a list of objecttypes

Field	Datatype	Size	Comment
no	Int		Object type. 1 – 8
project	Int		1)
container	Int		2)
name	String	10	Object type name

Value	Comment
0	If objects are to be used as expense objects
1	If objects are to be used as project objects

Value	Comment
0	if objects are not included in balancing (container.o{1-8})
1	if objects are included in balancing (container.o{1-8})

Get method : /api/object/get-objects-by-date

This method returns a list of objects

Inputfield	Datatype	Comment
startDate	Datetime	Object startdate
endDate	Datetime	Object enddate
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
no	Int		Object type. 1 – 8
name	String	30	Object name
objectId	String	64	Object id
businessUnit	String	8	Company. Can be null
userGroup1	String	64	Free group of group type OBJECT{no}-1
userGroup2	String	64	Free group of group type OBJECT{no}-2
userGroup3	String	64	Free group of group type OBJECT{no}-3
userGroup4	String	64	Free group of group type OBJECT{no}-4
userGroup5	String	64	Free group of group type OBJECT{no}-5
userGroup6	String	64	Free group of group type OBJECT{no}-6
userGroup7	String	64	Free group of group type OBJECT{no}-7
userGroup8	String	64	Free group of group type OBJECT{no}-8
userGroup9	String	64	Free group of group type OBJECT{no}-9
userGroup10	String	64	Free group of group type OBJECT{no}-10
userGroup11	String	64	Free group of group type OBJECT{no}-11
userGroup12	String	64	Free group of group type OBJECT{no}-12
userGroup13	String	64	Free group of group type OBJECT{no}-13
userGroup14	String	64	Free group of group type OBJECT{no}-14
userGroup15	String	64	Free group of group type OBJECT{no}-15
userGroup16	String	64	Free group of group type OBJECT{no}-16
userGroup17	String	64	Free group of group type OBJECT{no}-17
userGroup18	String	64	Free group of group type OBJECT{no}-18
userGroup19	String	64	Free group of group type OBJECT{no}-19
userGroup20	String	64	Free group of group type OBJECT{no}-20
o1	String	64	Standard object of type 1
o2	String	64	Standard object of type 2
o3	String	64	Standard object of type 3
o4	String	64	Standard object of type 4
o5	String	64	Standard object of type 5
o6	String	64	Standard object of type 6
o7	String	64	Standard object of type 7
o8	String	64	Standard object of type 8
objectBegin	Datetime		Valid from date
objectEnd	Datetime		Valid to date
balanced	Byte		0 – object is not balanced, 1 – object is balanced
balancedDirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced
action	Datetime		Change date
o1Relation	Int		1)
o2Relation	Int		1)
o3Relation	Int		1)
o4Relation	Int		1)
o5Relation	Int		1)
o6Relation	Int		1)
o7Relation	Int		1)
o8Relation	int		1)
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	0 – object can never be used with objects of type 1.
1	1 – object can be used with objects of type 1.
2	2 – object must be used with objects of type 1.

Get method : /api/object/get-objects-by-changedate

This method returns a list of objects

Inputfield	Datatype	Comment
changeDate	Datetime	Object startdate
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
no	Int		Object type. 1 – 8
name	String	30	Object name
objectId	String	64	Object id
businessUnit	String	8	Company. Can be null
userGroup1	String	64	Free group of group type OBJECT{no}-1
userGroup2	String	64	Free group of group type OBJECT{no}-2
userGroup3	String	64	Free group of group type OBJECT{no}-3
userGroup4	String	64	Free group of group type OBJECT{no}-4
userGroup5	String	64	Free group of group type OBJECT{no}-5
userGroup6	String	64	Free group of group type OBJECT{no}-6
userGroup7	String	64	Free group of group type OBJECT{no}-7
userGroup8	String	64	Free group of group type OBJECT{no}-8
userGroup9	String	64	Free group of group type OBJECT{no}-9
userGroup10	String	64	Free group of group type OBJECT{no}-10
userGroup11	String	64	Free group of group type OBJECT{no}-11
userGroup12	String	64	Free group of group type OBJECT{no}-12
userGroup13	String	64	Free group of group type OBJECT{no}-13
userGroup14	String	64	Free group of group type OBJECT{no}-14
userGroup15	String	64	Free group of group type OBJECT{no}-15
userGroup16	String	64	Free group of group type OBJECT{no}-16
userGroup17	String	64	Free group of group type OBJECT{no}-17
userGroup18	String	64	Free group of group type OBJECT{no}-18
userGroup19	String	64	Free group of group type OBJECT{no}-19
userGroup20	String	64	Free group of group type OBJECT{no}-20
o1	String	64	Standard object of type 1
o2	String	64	Standard object of type 2
o3	String	64	Standard object of type 3
o4	String	64	Standard object of type 4
o5	String	64	Standard object of type 5
o6	String	64	Standard object of type 6
o7	String	64	Standard object of type 7
o8	String	64	Standard object of type 8
objectBegin	Datetime		Valid from date
objectEnd	Datetime		Valid to date
balanced	Byte		0 – object is not balanced, 1 – object is balanced
balancedDirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced
action	Datetime		Change date
o1Relation	Int		1)
o2Relation	Int		1)
o3Relation	Int		1)
o4Relation	Int		1)
o5Relation	Int		1)
o6Relation	Int		1)
o7Relation	Int		1)
o8Relation	int		1)
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	0 – object can never be used with objects of type 1.
1	1 – object can be used with objects of type 1.
2	2 – object must be used with objects of type 1.

Post method: /api/object/create-update-object

This method creates or updates an object. Provide all the values if this method is used for updating

an object

Inputfield	Datatype	Size	Comment
no	Int		Object type. 1 – 8
name	String	30	Object name
objectId	String	64	Object id
businessUnit	String	8	Company. Can be null
userGroup1	String	64	Free group of group type OBJECT{no}-1
userGroup2	String	64	Free group of group type OBJECT{no}-2
userGroup3	String	64	Free group of group type OBJECT{no}-3
userGroup4	String	64	Free group of group type OBJECT{no}-4
userGroup5	String	64	Free group of group type OBJECT{no}-5
userGroup6	String	64	Free group of group type OBJECT{no}-6
userGroup7	String	64	Free group of group type OBJECT{no}-7
userGroup8	String	64	Free group of group type OBJECT{no}-8
userGroup9	String	64	Free group of group type OBJECT{no}-9
userGroup10	String	64	Free group of group type OBJECT{no}-10
userGroup11	String	64	Free group of group type OBJECT{no}-11
userGroup12	String	64	Free group of group type OBJECT{no}-12
userGroup13	String	64	Free group of group type OBJECT{no}-13
userGroup14	String	64	Free group of group type OBJECT{no}-14
userGroup15	String	64	Free group of group type OBJECT{no}-15
userGroup16	String	64	Free group of group type OBJECT{no}-16
userGroup17	String	64	Free group of group type OBJECT{no}-17
userGroup18	String	64	Free group of group type OBJECT{no}-18
userGroup19	String	64	Free group of group type OBJECT{no}-19
userGroup20	String	64	Free group of group type OBJECT{no}-20
objectBegin	Datetime		Valid from date
objectEnd	Datetime		Valid to date
balanced	Byte		0 – object is not balanced, 1 – object is balanced
balancedDirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced
o1	String	64	Standard object of type 1
o2	String	64	Standard object of type 2
o3	String	64	Standard object of type 3
o4	String	64	Standard object of type 4
o5	String	64	Standard object of type 5
o6	String	64	Standard object of type 6
o7	String	64	Standard object of type 7
o8	String	64	Standard object of type 8
o1Relation	Int		1)
o2Relation	Int		1)
o3Relation	Int		1)
o4Relation	Int		1)
o5Relation	Int		1)
o6Relation	Int		1)
o7Relation	Int		1)
o8Relation	int		1)

Value	Comment
0	0 – object can never be used with objects of type 1.
1	1 – object can be used with objects of type 1.
2	2 – object must be used with objects of type 1.

Patch method: /api/object/{objno}/{objId}

This method will update an object

Inputfield	Datatype	Size	Comment
objNo	Int		Object type. 1 – 8
objId	String	64	Object Id

The following fields can be used

Field	Datatype	Size	Comment
cid	String	8	Company. Can be null
name	String	30	Object name
usergroup1	String	64	Free group of group type OBJECT{no}-1
usergroup2	String	64	Free group of group type OBJECT{no}-2
usergroup3	String	64	Free group of group type OBJECT{no}-3
usergroup4	String	64	Free group of group type OBJECT{no}-4
usergroup5	String	64	Free group of group type OBJECT{no}-5
usergroup6	String	64	Free group of group type OBJECT{no}-6
usergroup7	String	64	Free group of group type OBJECT{no}-7
usergroup8	String	64	Free group of group type OBJECT{no}-8
usergroup9	String	64	Free group of group type OBJECT{no}-9
usergroup10	String	64	Free group of group type OBJECT{no}-10
usergroup11	String	64	Free group of group type OBJECT{no}-11
usergroup12	String	64	Free group of group type OBJECT{no}-12
usergroup13	String	64	Free group of group type OBJECT{no}-13
usergroup14	String	64	Free group of group type OBJECT{no}-14
usergroup15	String	64	Free group of group type OBJECT{no}-15
usergroup16	String	64	Free group of group type OBJECT{no}-16
usergroup17	String	64	Free group of group type OBJECT{no}-17
usergroup18	String	64	Free group of group type OBJECT{no}-18
usergroup19	String	64	Free group of group type OBJECT{no}-19
usergroup20	String	64	Free group of group type OBJECT{no}-20
objectbegin	Datetime		Valid from date
objectend	Datetime		Valid to date
Balanced	Byte		0 – object is not balanced, 1 – object is balanced
balanceddirect	Byte		0 – object is not directly balanced, 1 – object is directly balanced

Request body

Period

Get method : /api/period/get-years

This method returns a list of years and numbers of periods

Field	Datatype	Size	Comment
yearno	Short		Year id (index). First year’s index is 1
periodbegin	Datetime		Start date of period
periodend	Datetime		End date of period
locked	Byte		0 – period is unlocked, 1 – period is locked
Name	String	8	Period name

Get method : /api/period/get-periods

This method returns a list of period information

Field	Datatype	Size	Comment
yearno	Short		Year id (index). First year’s index is 1
period1	Byte		Period number. (0 – for the whole financial year record)
periodbegin	Datetime		Start date of period
periodend	Datetime		End date of period
locked	Byte		0 – period is unlocked, 1 – period is locked
name	String	8	Period name

PeriodAllocation

Get method : /api/periodallocation/get-periodallocation

This method returns a periodic allocation

Inputfield	Datatype	Comment
periodAllocationId	Int	Period allocation id

Field	Datatype	Size	Comment
businessUnit	String	8	Company
enumerator	Int		Internal batch number to identify the periodic allocation
describe	String	30	Description
baseAccount	String	6	Base account
startDate	Datetime		Start date
endDate	Datetime		End date
account	String		Account
amount	Decimal	28,8	Amount for allocation
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
currency	String	3	Currency
o1	String	64	Object of objkect type 1
o2	String	64	Object of objkect type 2
o3	String	64	Object of objkect type 3
o4	String	64	Object of objkect type 4
o5	String	64	Object of objkect type 5
o6	String	64	Object of objkect type 6
o7	String	64	Object of objkect type 7
o8	String	64	Object of objkect type 8
xFreeText	String	30	Free text
periodicRows
businessUnit	String	8	Company
enumerator	Int		Internal batch number to identify the periodic allocation
year	Short		Year
period	Byte		Period
amount	Decimal	28,8	Allocated amount
foramount	Decimal	28,8	Allocated foreign amount
number	Decimal	28,8	Allocated number
done	Byte		0 – allocation is not yet done, 1 – allocation is done

Get method : /api/periodallocation/{businessUnitId}/{page}

This method returns the periodic allocation list for a business unit with pagination

Inputfield		Datatype	Size	Comment
businessUnitId	S	tring	8	Company
page i		nt	Page to get. Default page is 0

Field	Datatype	Size	Comment
businessUnit	String	8	Company
enumerator	Int		Internal batch number to identify the periodic allocation
describe	String	30	Description
baseAccount	String	6	Base account
startDate	Datetime		Start date
endDate	Datetime		End date
account	String		Account
amount	Decimal	28,8	Amount for allocation
foramount	Decimal	28,8	Foreign amount
number	Decimal	28,8	Number
currency	String	3	Currency
o1	String	64	Object of objkect type 1
o2	String	64	Object of objkect type 2
o3	String	64	Object of objkect type 3
o4	String	64	Object of objkect type 4
o5	String	64	Object of objkect type 5
o6	String	64	Object of objkect type 6
o7	String	64	Object of objkect type 7
o8	String	64	Object of objkect type 8
xFreeText	String	30	Free text
periodicRows
businessUnit	String	8	Company
enumerator	Int		Internal batch number to identify the periodic allocation
year	Short		Year
period	Byte		Period
amount	Decimal	28,8	Allocated amount
foramount	Decimal	28,8	Allocated foreign amount
number	Decimal	28,8	Allocated number
done	Byte		0 – allocation is not yet done, 1 – allocation is done
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch
totalNumberOfRecords	String

Person

Get method : /api/person/get-customers

This method returns a list of customers

Inputfield	Datatype	Comment
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Property bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency

acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-customers-by-changedate

This method returns a list of customers

Inputfield	Datatype	Comment
changedate	Datetime	Change date greater or equal
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account

contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-suppliers

This method returns a list of suppliers

Inputfield	Datatype	Comment
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person

group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-suppliers-by-changedate

This method returns a list of suppliers

Inputfield	Datatype	Comment
changedate	Datetime	Change date greater or equal
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account

contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
pageNumber	Int		Page to fetch. First page = 0
isComplete	Bool		True – more pages to fetch

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-addresses

This method returns a list of addresses

Inputfield	Datatype	Comment
type	Int	-1 – supplier, 1 – customer

Field	Datatype	Size	Comment
type	Int		-1 – supplier, 1 – customer
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Webaddress
email	String	255	e-mail address
uac	Int		User Access Code

Get method : /api/person/get-address

This method returns a list of addresses

Inputfield	Datatype	Size	Comment
owner	String	12	Supplier/Customer Id
type	Int		Type. -1 – supplier, 1 – customer

Field	Datatype	Size	Comment
type	Int		-1 – supplier, 1 – customer
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Webaddress
email	String	255	e-mail address
uac	Int		User Access Code

Get method : /api/person/get-customer-additionaldata-by-id

This method returns a customer with address, payment terms and contacts

Inputfield		Datatype	Size	Comment
customerId	S	tring	12	Customer id

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person

group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
address:
type	Int		-1 – supplier, 1 – customer
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
uac	Int		User Access Code
days	Short		Number of days before the due date
contacts:
id	String	8	Contact id
owner	String	12	Owner of the contact. Refers to person.id
type	Short		Owner type. -1 – supplier / 1 – customer
name	String	30	Name of contact
title	String	15	Title
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Webaddress
email	String	255	e-mail address

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-suppliers-additionaldata

This method returns a supplier with address, payment terms, contacts and banks

Inputfield	Datatype	Comment
changedate	Datetime	Change date greater or equal
page	Int	Page to get. Default page is 0

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account

contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
address:
type	Int		-1 – supplier, 1 – customer
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
uac	Int		User Access Code
days	Short		Number of days before the due date
contacts:
id	String	8	Contact id
owner	String	12	Owner of the contact. Refers to person.id
type	Short		Owner type. -1 – supplier / 1 – customer
name	String	30	Name of contact
title	String	15	Title
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Webaddress
email	String	255	e-mail address
banks:
id	String	8	Bank id
type	Short		-1 – supplier, 0 – company
mop	String	8	Mode of payment
owner	String	12	Bank owner id.

bankType	String	8	Type of group BANKTYPE
number	String	40	Account number
swift	String	30	Swift address
clearing	String	30	Clearing number
bankName	String	30	Bank name
freeText	String	255	Free text
address1	String	40	First address
address2	String	40	Second address
address3	String	40	Third address
address4	String	40	Fourth address
group1	String	64	Group of group type BANK1
group2	String	64	Group of group type BANK2
group3	String	64	Group of group type BANK3
group4	String	64	Group of group type BANK4
defBank	Int		0 – not a default bank, 1 – default bank
paymentaccount	String	6	Account. This account is used for payment with Autopay
currency	String	3	currency
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Get method : /api/person/get-supplier-additionaldata-by-id

This method returns a supplier with address, payment terms, contacts and banks

Inputfield	Datatype	Size	Comment
supplierId	String	12	Id of supplier

Field	Datatype	Size	Comment
type	Short		Person type, 1 – customer, -1 – supplier
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person

group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4
group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
address:
type	Int		-1 – supplier, 1 – customer
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
uac	Int		User Access Code
days	Int		Number of days before the due date
contacts:
id	String	8	Contact id
owner	String	12	Owner of the contact. Refers to person.id
type	Short		Owner type. -1 – supplier / 1 – customer
name	String	30	Name of contact
title	String	15	Title
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Webaddress
email	String	255	e-mail address
banks:
id	String	8	Bank id
type	Short		-1 – supplier, 0 – company
mop	String	8	Mode of payment
owner	String	12	Bank owner id.
bankType	String	8	Type of group BANKTYPE

number	String	40	Account number
swift	String	30	Swift address
clearing	String	30	Clearing number
bankName	String	30	Bank name
freeText	String	255	Free text
address1	String	40	First address
address2	String	40	Second address
address3	String	40	Third address
address4	String	40	Fourth address
group1	String	64	Group of group type BANK1
group2	String	64	Group of group type BANK2
group3	String	64	Group of group type BANK3
group4	String	64	Group of group type BANK4
defBank	Int		0 – not a default bank, 1 – default bank
paymentaccount	String	6	Account. This account is used for payment with Autopay
currency	String	3	currency

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Post method : /api/person/create-customer

This method creates a customer

Inputfield	Datatype	Size	Comment
customer:
type	Short		1
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4

group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
address:
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
deliveryaddress:
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
contact:
id	String	8	Contact id
owner	String	12	Owner of the contact. Refers to person.id
type	Short		Owner type. -1 – supplier / 1 – customer
name	String	30	Name of contact
title	String	15	Title
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Webaddress

email	String	255	e-mail address
eInvoiceId	String		Not used yet

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Field	Datatype	Comment
Success	Bool	true – succesful, false – not succesful
Result	Int
errorMessage	String	Errormessage

Patch method : /api/customer/{custid} This method will update a customer.

Inputfield	Datatype	Size	Comment
custid	String	12	Person id

The fields that can be updated can be found in endpoint Post method : /api/person/create-customer in section “customer” Request body 153

Patch method : /api/supplier/{supplierid} This method will update a supplier.

Inputfield	Datatype	Size	Comment
supplierid	String	12	Person id

The fields that can be updated can be found in endpoint Post method : /api/person/create-supplier in section “supplier” Request body 154

Post method : /api/person/create-supplier

This method creates a supplier

Inputfield	Datatype	Size	Comment
customer:
type	Short		-1
id	String	12	Person id
globaltype	Byte		1)
internaltype	Byte		2)
created	Datetime		Date of creation
changed	Datetime		Date of last modification
noclaim	Byte		Set to 1 if reminders should not be generated
nointerest	Byte		Set to 1 if interests should not be calculated
blocked	Byte		Set to 1 if the customer/supplier is blocked
statement	Byte		Set to 1 for the account statement
creditlimit	Decimal	28,8	Credit limit
creditlimitoff	Decimal	28,8	Allowed overdraft for credit limit
extradays	Short		Wait days after the due date within which the invoice can still be paid
fixedexchange	Byte		Set to 1 if fixed exchange should be used for payments
disabled	Byte		Set to 1 if customer/supplier should not be used
ignoreorginvno	Byte		Setting for original invoice number
gln	String	40	Global Location Number
prop	Int		Proerty bitmask
uac	Int		User Access Code
totalsaldo	Decimal	28,8	Total balance
pricelist	Byte		Price list that should be used
invdiscount	Decimal	28,8	Invoice discount
accounttype	Byte		Account that should be used for invoicing
groupinvoice	Byte		Set to 1 if summary invoice is to be used
invoicefee	Decimal	28,8	Invoice fee
extrafee	Decimal	28,8	Administration fee
usefee	Byte		Set to 1 if local invoice fee should be used
useextrafee	Byte		Set to 1 if administration fee should be used
useintfee	Byte		Set to 1 if local interest fee shoud be used
intfee	Decimal	28,8	Interest fee
useremfee	Byte		Set to 1 if reminder fee should be charged from customer
remfee	Decimal	28,8	Reminder fee
discountcol	Int		Discount column for invoicing
mod	String	8	Method of delivery of group type MOD
tod	String	8	Terms of delivery of group type TOD
bankcode	String	8	Central bank code of group type BANKCODE
cashdiscount	String	8	Default cash distount
interest	String	8	Default interest procedure
payer	Byte		Set to 1 if customer is a payer
defpayer	String	12	Default payer
payee	Byte		Set to 1 if customer is a payee
defpayee	String	12	Default payee
receive	Byte		Set to 1 if customer is an invoice recipient
defreceive	String	12	Default invoice resipient
o1	String	8	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
currency	String	3	Currency
acctabrec	String	8	Account receivable for customer / account payable for supplier
acctabsale	String	8	Sale account / purchase account
contact	String	8	Default contact person
group1	String	64	Group of type CUST1 or SUPP1
group2	String	64	Group of type CUST2 or SUPP2
group3	String	64	Group of type CUST3 or SUPP3
group4	String	64	Group of type CUST4 or SUPP4

group5	String	64	Group of type CUST5 or SUPP5
group6	String	64	Group of type CUST6 or SUPP6
approval1	String	8	Approval 1
approval2	String	8	Approval 2
payform	String	8	Payform of group type PAYFORM
feecode	String	8	Fee code of group type FEECODE
factoring	String	8	Bank that is used for factoring
claimdate	Datetime		Latest reminder date
intdate	Datetime		Lastes calculation of interest
creditresponse	String	8	Credit administrator
action	Datetime		Latest action upon the customer/supplier
xtop	String	8	Default terms of payment
mop	String	8	Default mode of payment
claim	String	8	Reminder code to create reminders for customer
response	String	8	Administrator
code	String	30	Customer / supplier code
countrycode	String	8	Country code of group type COUNTRY
languagecode	String	8	Language code of group type LANGID
name	String	80	Name of person
alpha	String	80	Search name
vatno	String	30	VAT registration number
extraid	String	40	Extra id
countrytype	String	8	Country type of group type CNTTYPE
numberofempoyees	String		Number of employees
address:
id	String	12	Customer/suppier id
sid	String	12	Empty for main address, DLV for delivery address
lA1	String	40	First long address
lA2	String	40	Second long address
lA3	String	40	Fhird long address
lA4	String	40	Fourth long address
sA1	String	40	First short address
sA2	String	40	Second short address
sA3	String	40	Fhird short address
sA4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address
bank
id	String	8	Bank id
type	Short		-1
mop	String	8	Mode of payment
owner	String	12	Bank owner id.
bankType	String	8	Type of group BANKTYPE
number	String	40	Account number
swift	String	30	Swift address
clearing	String	30	Clearing number
bankName	String	30	Bank name
freeText	String	255	Free text
address1	String	40	First address
address2	String	40	Second address
address3	String	40	Third address
address4	String	40	Fourth address
group1	String	64	Group of group type BANK1
group2	String	64	Group of group type BANK2
group3	String	64	Group of group type BANK3
group4	String	64	Group of group type BANK4
defBank	Int		0 – not a default bank, 1 – default bank
paymentaccount	String	6	Account. This account is used for payment with Autopay
currency	String	3	currency

Value	Comment
0	external customer/supplier
1	concern customer/supplier
2	internal customer/supplier

Value	Comment
0	ordinary customer/supplier
1	prospect
2	template

Field	Datatype	Comment
success	Bool	true – succesful, false – not succesful
result	Int
errorMessage	String	Errormessage

Delete method : /api/person/delete-supplier-bank

This method deletes a bank from a supplier

Inputfield	Datatype	Size	Comment
bankid	String	8	The id of the bank
bankOwner	String	12	The owner of the bank

Field	Datatype	Size	Comment
response	Bool		True/False

Patch method: /api/address/{addressType}/customer/{custId}

This method will update a customer address. The following fields can be used

Field	Datatype	Size	Comment
la1	String	40	First long address
la2	String	40	Second long address
la3	String	40	Fhird long address
la4	String	40	Fourth long address
sa1	String	40	First short address
sa2	String	40	Second short address
sa3	String	40	Fhird short address
sa4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address

Inputfield	Datatype	Size	Comment
addressType	String	3	DLV, INV
custid	String	12	Person id

Request body

Patch method: /api/address/supplier/{supplierId}

This method will update a supplier address. The following fields can be used

Field	Datatype	Size	Comment
la1	String	40	First long address
la2	String	40	Second long address
la3	String	40	Fhird long address
la4	String	40	Fourth long address
sa1	String	40	First short address
sa2	String	40	Second short address
sa3	String	40	Fhird short address
sa4	String	40	Fourth short address
phone1	String	30	First number
phone2	String	30	Second number
phone3	String	30	Fhird number
www	String	255	Internet address
email	String	255	e-mail address

Inputfield	Datatype	Size	Comment
supplierid	String	12	Person id

Request body

Patch method: /api/contact/{owner}/customer/{custId}

This method will update a customer contact. The following fields can be used

Field	Datatype	Size	Comment
name	String	30	Name of contact
title	String	15	Title of contact
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Internet address
email	String	255	e-mail address

Inputfield	Datatype	Size	Comment
owner	String	12	Owner of the contact
supplierid	String	12	Person id

Request body

Patch method: /api/contact/{owner}/supplier/{supplierId}

This method will update a supplier contact. The following fields can be used

Field	Datatype	Size	Comment
name	String	30	Name of contact
title	String	15	Title of contact
phone1	String	30	First number
phone2	String	30	Second number
www	String	255	Internet address
email	String	255	e-mail address

Inputfield	Datatype	Size	Comment
owner	String	12	Owner of the contact
supplierid	String	12	Supplier id

Request body

Patch method: /api/bank/{bankId}/supplier/{supplierId}

This method will update a supplier bank. The following fields can be used

Field	Datatype	Size	Comment
mop	String	8	Mode of payment
banktype	Short		Bank type of group “BANKTYPE”.
number	String	40	Account number
swift	String	30	Swift address
clearing	String	30	Clearing number
bankname	String	30	Bank name
address1	String	40	First address
address2	String	40	Second address
address3	String	40	Third address
address4	String	40	Fourth address
xfreetext	String	255	Free text
group1	String	64	Group of group type BANK1
group2	String	64	Group of group type BANK2
group3	String	64	Group of group type BANK3
group4	String	64	Group of group type BANK4
defbank	Byte		0 – not a default bank, 1 – default bank

Inputfield	Datatype	Size	Comment
bankid	String	8	Bank ID
supplierid	String	12	Bank owner ID

Request body

Patch method: /api/bank/{bankId}/businessunit/{businessunitId}

This method will update a supplier bank. The following fields can be used

Field	Datatype	Size	Comment
mop	String	8	Mode of payment
banktype	Short		Bank type of group “BANKTYPE”.
number	String	40	Account number
swift	String	30	Swift address
clearing	String	30	Clearing number
bankname	String	30	Bank name
address1	String	40	First address
address2	String	40	Second address
address3	String	40	Third address
address4	String	40	Fourth address
xfreetext	String	255	Free text
group1	String	64	Group of group type BANK1
group2	String	64	Group of group type BANK2
group3	String	64	Group of group type BANK3
group4	String	64	Group of group type BANK4
defbank	Byte		0 – not a default bank, 1 – default bank

Inputfield	Datatype	Size	Comment
bankid	String	8	Bank ID
businessunit	String	12	Bank owner ID

Request body

StorageSpace

Get method : /api/storage/control

This method returns the list of Control storages associated with the current tenant

Field	Datatype	Size	Comment
databaseName	String		Name of database
storageSpaceId	String		Database Id

Get method : /api/storage/control/{userId}

This method returns the list of Control storages associated with the specified userId

Inputfield	Datatype	Size	Comment
userid	String		Userid from Connect

Field	Datatype	Size	Comment
databaseName	String		Name of database
storageSpaceId	String		Database Id

TermsOfPayment

Get method : /api/termsofpayment/{id}

This method returns terms of payment based on Id

Inputfield	Datatype	Size	Comment
id	String	8	Terms of payment id

Field	Datatype	Size	Comment
id	String	8	Term of payment id.
description	String	30	Description.
langtext	String	8	Language dependent text id. Refers to languagetext id.
days	Int		Numbers of days before the due date.
intdays	Int		Numbers of days before the interest starts being calculated.
daysinterest	Int		Number of days before the due date for interast invoices.
freemonth	Int		0 = not freemonth, 1 = free month.

Post method : /api/termsofpayment

This method creates terms of payment

Inputfield	Datatype	Size	Comment
id	String	8	Terms of payment id
description	String	30	Description.
langtext	String	8	Language dependent text id. Refers to languagetext id.
days	Int		Numbers of days before the due date.
intdays	Int		Numbers of days before the interest starts being calculated.
daysinterest	Int		Number of days before the due date for interast invoices.
freemonth	Int		0 = not freemonth, 1 = free month.

UserGroup

Get method : /api/usergroup/get-usergroups

This method returns a list of usergroups

Inputfield	Datatype	Size	Comment
page	Int		Page to get. Default page is 0

Field	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	8	Group id
groupdesc	String	20	Description
text	String	80	Free text
uac	Int		User Access Code
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Get method : /api/usergroup/{typename}/{groupname}

This method returns a usergroup based on typename and groupname

Inputfield	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	20	Group id

Field	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	8	Group id
groupdesc	String	20	Description
text	String	80	Free text
uac	Int		User Access Code

Put method : /api/usergroup/{typename}/{groupname}

This method edits an user group based on typename and groupname. Request body is the data to be

saved

Inputfield	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	20	Group id
Request body
typename	String	10	Group type
groupname	String	8	Group id
groupdesc	String	20	Description
text	String	80	Free text

Field	Datatype	Size	Comment
entityId	String
entityType	String

Get method : /api/usergroup/get-usergroupbytype

This method returns a user group

Inputfield	Datatype	Size	Comment
typename	String	10	Group type

Field	Datatype	Size	Comment
typename	String	10	Group type
groupname	String	8	Group id
uac	Int		User Access Code
groupdesc	String	20	Description
text	String	80	Free text

Post method : /api/usergroup

This method adds an user group

Inputfield	Datatype	Size	Comment
Request body
typename	String	10	Group type
groupname	String	8	Group id
groupdesc	String	20	Description
text	String	80	Free text

Field	Datatype	Size	Comment
entityId	String
entityType	String

Voucher

Post method : /api/voucher/create-voucher

This method creates a voucher

Inputfield	Datatype	Size	Comment
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Int		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
userid	String	30	User id
userGroup1	String	128	Group type of type VOUCHER1
userGroup2	String	128	Group type of type VOUCHER2
freeText	String	80	Free text
rows:
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type VOUROW1
group2	String	64	Free group of type VOUROW2
group3	String	64	Free group of type VOUROW3
group4	String	64	Free group of type VOUROW4

Field	Datatype	Size	Comment
success	Bool		true – succesful, false – not succesful
result:
businessUnit	String	8	Company
Serie	String	8	Voucher serie
vouNo	Int		Voucher number
Type	Short		Ledger type
enumerator	String	8	Invoice serie
Invno	Int		Invoive number
voucherDate	Datetime		Voucher date
Userid	String	30	User id
userGroup1	String	8	Group type of type VOUCHER1
userGroup2	String	8	Group type of type VOUCHER2
freeText	String	80	Free text
rows:
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency

number	Decimal	28,8	Number
freeText	String	80	Free text
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
altered	Byte		0 – no change, 1 – added row, 2 – deleted row
bookDate	Datetime		Accounting date
serie	String	8	Voucher serie
rowNo	Short		Row number
year	Byte		Year number
period	Byte		Period number
resaccount	String	6	Profit/loss account if one of the objects is balanced
extraAmount	Decimal	28,8	Extra amount
vatCode	Short		VAT code
crType	Byte		1)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmount	Decimal	28,8	Amount in alternative currency
hasAttachment	Bool		Not used here
errorMessage	String		Errormessage if not successful

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

Get method : /api/voucher/{voucherSerie}/{voucherNumber}/{year}

This method returns a voucher and it’s voucherrows

Inputfield	Datatype	Size	Comment
voucherSerie	String	8	Voucher serie
voucherNumber	Int	Voucher number
year	Int	Year

Field	Datatype	Size	Comment
success	Bool		True/false
result:
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	short		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
updatedOn	Datetime		Date when the voucher has been saved
userid	String	30	User id
userGroup1	String	8	Group type of type VOUCHER1
userGroup2	String	8	Group type of type VOUCHER2
freeText	String	80	Free text
transferlog	Bool		Not use here
rows:
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type VOUROW1
group2	String	64	Free group of type VOUROW2
group3	String	64	Free group of type VOUROW3
group4	String	64	Free group of type VOUROW4
altered	Byte		1)
bookDate	Datetime		Bookingdate
serie	String	8	Voucher serie
rowNo	Short		Row number starting with 0
year	Short		Year
period			Period
resaccount	String	6	Profit/loss account if one of the objects is balanced.
extraAmount	Numeric	28,8	Extra amount
vatCode	Short		Vat code
crType	Byte		2)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmount	Numeric	28,8	Amount in alternative currency
hasAttachment	Bool		True – has a saved attachment, false – has no attachment

errorMessage	String
operion	Int

Value	Comment
0	No change
1	Row added
2	Row is deleted

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

Get method : /api/voucher/get-voucherrows

This method returns a list of voucherrows

Inputfield	Datatype	Comment
date	Datetime	Return rows created or updated on input date and after. (1)
page	Int	Page to get. Default page is 0

(1)

Where voucher.voucounter >= date (voucounter is modification date – when voucher rows where

last changed)

Field	Datatype	Size	Comment
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Number
freeText	String	80	Free text
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
altered	Byte		0 – no change, 1 – added row, 2 – deleted row
bookDate	Datetime		Accounting date
serie	String	8	Voucher serie
rowNo	Short		Row number
year	Byte		Year number
period	Byte		Period number
resaccount	String	6	Profit/loss account if one of the objects is balanced
extraAmount	Numeric	28,8	Extra amount
vatCode	Short		VAT code
crType	Byte		1)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmount	Decimal	28,8	Amount in alternative currency
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

Get method : /api/voucher/get-vouchers

This method returns a list of vouchers

Inputfield	Datatype	Comment
date	Datetime	Return voucgers created or upated on input date and after. (1)
page	Int	Page to get. Default page is 0

(1)

Where voucher.voucounter >= date (voucounter is modification date – when voucher rows where

last changed)

Field	Datatype	Size	Comment
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Short		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
userid	String	30	User id
userGroup1	String	8	Group type of type VOUCHER1
userGroup2	String	8	Group type of type VOUCHER2
freeText	String	80	Free text
yeaNo	Byte		Year number
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Get method : /api/voucher/get-voucher-by-dates

This method returns a list of vouchers

Inputfield	Datatype	Comment
bookingDateFrom	Datetime	Start date. (1)
bookingDateTo	Datetime	End date. (1)
page	Int	Page to get. Default page is 0

(1)

Where voucher.date between bookingDateFrom and bookingDateTo

Field	Datatype	Size	Comment
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Short		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
userid	String	30	User id
userGroup1	String	128	Group type of type VOUCHER1
userGroup2	String	128	Group type of type VOUCHER2
freeText	String	80	Free text
yeaNo	Byte		Year number
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Get method : /api/voucher/get-voucherrow-by-dates

This method returns a list of voucherrows

Inputfield	Datatype	Comment
bookingDateFrom	Datetime	Start date. (1)
bookingDateTo	Datetime	End date, (1)
page	Int	Page to get. Default page is 0

(1)

Where voucher.date between bookingDateFrom and bookingDateTo

Field	Datatype	Size	Comment
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Number
freeText	String	80	Free text
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
altered	Byte		0 – no change, 1 – added row, 2 – deleted row
bookDate	Datetime		Accounting date
serie	String	8	Voucher serie
rowNo	Short		Row number
year	Byte		Year number
period	Byte		Period number
resaccount	String	6	Profit/loss account if one of the objects is balanced
extraAmount	Decimal	28,8	Extra amount
vatCode	Short		VAT code
crType	Byte		1)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmount	Decimal	28,8	Amount in alternative currency
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

Post method : /api/voucher/voucherrows/filter

This method returns a list of voucherrows based on filter

Filter

Input	Datatype	Comment
filters:
fieldName	String	1)
operator	Enum	2)
value	String
secondValue	String
page	Int	Page to fetch. First page = 0

1) Field BusinessUnit Vouno Account Amount Foramount Currency Number O1 O2 O3 O4 O5 O6 O7 O8 2)

Operator	Comment
Equal	Exact match
Include	In operation with comma-seperated values
Between	Range between two values (requires secondvalue)
GreaterThan	Greater than comparison
LessThan	Less than comparison

Field	Datatype	Size	Comment
list:
businessUnit	String	8	Company
vouNo	Int		Voucher number
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Number
freeText	String	80	Free text
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of group type VOUROW1
group2	String	64	Free group of group type VOUROW2
group3	String	64	Free group of group type VOUROW3
group4	String	64	Free group of group type VOUROW4
altered	Byte		0 – no change, 1 – added row, 2 – deleted row
bookDate	Datetime		Accounting date
serie	String	8	Voucher serie
rowNo	Short		Row number
year	Byte		Year number
period	Byte		Period number
resaccount	String	6	Profit/loss account if one of the objects is balanced
extraAmount	Decimal	28,8	Extra amount
vatCode	Short		VAT code
crType	Byte		1)
creator	String	30	Creator
baseCurrency	String	3	Alternative currency
baseAmount	Decimal	28,8	Amount in alternative currency
hasAttachment	Bool		True – has a saved attachment, false – has no attachment
pageNumber	Int		Page to fetch. First page = 0
isCompleted	Bool		True – more pages to fetch
totalNumberOfRecords	String

Value	Comment
0	not specified
1	asset
2	periodic allocation
3	autocoding
4	supplier
5	customer

VoucherLog

Get method : /api/voucherlog/get-voucherlog-by-Id

This method returns a voucher log

Inputfield	Datatype	Size	Comment
vouno	Int		Voucher number
serie	String	8	Voucher serie
year	Int		Year number

Field	Datatype	Size	Comment
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
Type	short		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
userid	String	30	User id
userGroup1	String	128	Group type of type VOUCHER1
userGroup2	String	128	Group type of type VOUCHER2
freeText	String	80	Free text
transferlog	Bool		Not use here
checkRule	Byte		Not used here
rows:
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	2838	Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type VOUROW1
group2	String	64	Free group of type VOUROW2
group3	String	64	Free group of type VOUROW3
group4	String	64	Free group of type VOUROW4
vatCode	Short		Vat code

Post method : /api/voucherlog/create-voucherlog

This method creates a voucher log

Inputfield	Datatype	Size	Comment
businessUnit	String	8	Company
serie	String	8	Voucher serie
vouNo	Int		Voucher number
type	Short		Ledger type
enumerator	String	8	Invoice serie
invno	Int		Invoive number
voucherDate	Datetime		Voucher date
userid	String	30	User id
userGroup1	String	128	Group type of type VOUCHER1
userGroup2	String	128	Group type of type VOUCHER2
freeText	String	80	Free text
transferlog	Bool		True – transfer, false – do not transfer
checkRule	Byte		0 – do not check rules on transfer, 1 – check rules on transfer
deleteaftertransfer	Bool		False – No delete, True = delete after transfer
rows:
account	String	6	Account
amount	Decimal	28,8	Amount
foramount	Decimal	28,8	Foreign amount
currency	String	3	Currency
number	Decimal	28,8	Quantity
freeText	String	80	Freetext
o1	String	64	Object of type 1
o2	String	64	Object of type 2
o3	String	64	Object of type 3
o4	String	64	Object of type 4
o5	String	64	Object of type 5
o6	String	64	Object of type 6
o7	String	64	Object of type 7
o8	String	64	Object of type 8
group1	String	64	Free group of type VOUROW1
group2	String	64	Free group of type VOUROW2
group3	String	64	Free group of type VOUROW3
group4	String	64	Free group of type VOUROW4
vatCode	Short		Vat code

Field	Datatype	Size	Comment
logno	Int		Log number
logtype	Short		1)
logdate	Datetime		Accounting date
type	Short		Ledger type
invno	Int		Invoice number
seq	Byte		Ledger sequential number
year	Short		Year number
period	Byte		Period number
serie	String	8	Voucher serie
pack	Byte		Set to 1 if identical rows should be bundled together
timestamp	Timestamp		Timestamp
vouno	Int		Voucher number
groupno	Int		Batch number
xfreetext	String	80	Free text
group1	String	128	Group type of type VOUCHER1
group2	String	128	Group type of type VOUCHER2
userid	String	30	User id
enumerator	String	8	Invoice serie
cid	String	8	Company
status	Short		0 – voucherlog, 1 – transfered to voucher, 2 – error
userserie	Byte		Voucher serie

Value	Comment
1	user-defined
2	accounting
3	sales ledger
4	supplier ledger
5	external system
6	arrival registration

Note:

This method will create the voucherlog in one transaction and then after it’s imported try to

transfer the imported log. If the transfer of the log is not ok the log will still be created and a user can then correct and transfer manually.

Do not send many logs at the same time, wait for the result and then send the next one.

180

VoucherSerie

Get method : /api/serie/get-series

This method returns a list of voucherseries

Inputfield	Datatype	Comment
yearno	Int	Year number

Field	Datatype	Size	Comment
nextno	Int		Next number for voucher serie
disabled	Byte		0 – if serie is not locked, 1 – 40 – period until serie is locked
dmy	Byte		1)
freeuse	Byte		Serie does not lock when it is being used
locked	Byte		0 – unlocked, 1 – locked
year	Short		Year number
serie1	String	8	Serie id
type	Short		Container to which vouchers with this serie are aggregated. Used only if dmy value is 3. If dmy is 0, vouchers are aggregated into container 9 (container.type)
nosaldo	Byte		2)
uac	Int		User Access Code
cid	String	8	Company
describe	String	30	Description
userid	String	30	User who can use the voucher serie. NULL if the voucher serie can be used by all users
lockedby	String	30	User who locked the serie
usergroup1	String	64	Free group of group type VOUCHER1
usergroup2	String	64	Free group of group type VOUCHER2

Value	Comment
0	serie for vouchers
1	serie for templates
2	serie for simulations
3	serie for budget

Value	Comment
0	vouchers of this serie must be balanced
1	vouchers of this serie do not require balancing. Used only if dmy value is 3

Get method : /api/serie/get-userseries

This method returns a list of userseries

Inputfield	Datatype	Size	Comment
type	Int		1 – voucher series, 2 – ledger/invoice series
company	String	8	Company
userName	String	255	User id. Login id

Field	Datatype	Size	Comment
type	Byte		1 – voucher series, 2 – ledger/invoice series
company	String	8	Company
userName	String	30	User id. Login id
serie0	String	8	Default voucher serie, or ledger serie for invoicing
serie1	String	8	Voucher serie for invoicing, or ledger serie for sales ledgers
serie2	String	8	Voucher serie for customer payments, or ledger serie for supplier ledgers
serie3	String	8	Voucher serie for supplier payments, or ledger serie for interest invoices
serie4	String	8	Voucher serie for arrival registrations
serie5	String	8	Voucher serie for counter-bookings
serie6	String	8	Voucher serie for offsetting balance for objects
serie7	String	8	Voucher serie for periodic allocations
serie8	String	8	Voucher serie for budget
serie9	String	8	Voucher serie for sales ledgers
serie10	String	8	Voucher serie for supplier ledgers
serie11	String	8	Voucher serie for interests
serie12	String	8	Voucher serie for depreciations

IM endpoints

This section describes endpoints for IM 183

CaseHistory

Get method : /api/case-history/{caseId}

This method retrieves the case history records for a specific case ID

Inputfield	Datatype	Size	Comment
caseId	Int		Unique identifier of a case Id

Field	Datatype	Size	Comment
caseId	Int		Unique identifier of a case
eventTime	Datetime		Time at which the event happened
fromStepId	String	255	From step – id
toStepId	String	255	To step – Id
senderId	String	255	Sender Id
recipientId	String	255	Recipient Id

Get method : /api/case-history

This method retrieves paginated and filtered case history records

Inputfield	Datatype	Size	Comment
caseId	Int		Optional: Filter by a specific CaseId
fromDate	String	255	Optional: Start date for EventTime filter (e.g., YYYY-MM-DD)
toDate	String	255	Optional: End date for EventTime filter (e.g., YYYY-MM-DD)
pageNumber	Int		The current page number (1-based, default 1)
pageSize	Int		The number of records per page (default 1000)

Field	Datatype	Size	Comment
data:
caseId	Int		Unique identifier of a case Id
eventTime	Datetime		Time at which the event happened
fromStepId	String	255	From step - id
toStepId	String	255	To step - Id
senderId	String	255	Sender Id
recipientId	String	255	Recipient Id
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page
totalRecords	Int		Total number of records
totalPages	Int		Total pages
hasNextPage	Bool		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
isComplete	Bool		Indicates whether the current page is the final (or only) page.
			True when the current page number is greater than or equal to TotalPages

Message

Get method : /api/messages

This method retrieves messages with optional filtering and pagination

Inputfield	Datatype	Size	Comment
CreatedAfter	String		Message created after date
MessageId	Int	MessageId
PageNumber	Int	Page to fetch. First page = 1
PageSize	Int	Rows to fetch

Field	Datatype	Size
data:
messageId	Int
rowNumber	Int
messageText	String
creationDate	DateTime
signature	String
pageNumber	Int	Page to fetch. First page = 1
pageSize	Int	Number of items on each page
totalRecords	Int	Total number of records
totalPages	Int	Total pages
hasNextPage	Bool	Indicates if there is a subsequent page of results
hasPreviousPage	Bool	Indicates if there is a preceding page of results
isComplete	Bool	Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

RecurringTemplate

Get method : /api/recurring-templates

This method retrieves the recurring invoice template

Inputfield	Datatype	Size	Comment
UnitId	String	8	The identifier of the unit that the recurring template belongs to
SupplierId	String	32	The identifier of the supplier of the invoice
StartDate	String	8	The template start date
EndDate	String	8	The template end date
IncludeAccountingRows	Bool		True/False
PageNumber	Int		Page to fetch. First page = 1
PageSize	Int		Number of pages to get

Field	Datatype	Size	Comment
data:
id	Int		Unique identifier of the recurring template
unitId	String	32	The identifier of the unit that the invoice belongs to
name	String	255	Name of the recurring template
supplierId	String	32	The identifier of the supplier of the invoice
startDate	Datetime		Start date for when the template is valid
endDate	Datetime		End date for when the template is valid
originalInvoiceNumber	String	255	Invoice number to which the template should match
orderNumber	String	32	Order number to which Invoice template should match
foreignAmountFrom	Decimal	28,8	The foreign amount of the invoice to which recurring template should match
foreignAmountTo	Decimal	28,8	The foreign amount of the invoice to which recurring template should match
checkSignature	String	32	The check signature to use
attestSignature	String	32	The attest signature to use
numberImported	Int		Number of imported invoices matching this template
maxNumberImported	Int		Maximum allowed number of imported invoices matching this template
reference	String	255	Optional Reference of the invoice to which the recurring template should match
addVatCoding	Bool		Indicates whether VAT coding should be added automatically by the system, or
			not, when the template is applied
allocateGrossAmount	Bool		Indicates whether the gross or net invoice amount should be allocated when creating accounting rows according this template
supplierName	String	255	The name of the supplier of the recurring template
codingReference	String	255	Optional CodingReference of the invoice to which the recurring template should match
lastUsageDate	Datetime		The date when this template was last used
stopInCheck	Bool		Indicates whether the invoice should stop in the Check step, when being automatically processed
stopInAttest	Bool		Indicates whether the invoice should stop in the Attest step, when being
			automatically processed
createdBy	String	32	The user id of the user who created the template
createdUtc	Datetime		The date and time at which the template was created
accountingRows:
templateId	Int		Unique identifier of the recurring template
rowNumber	Int		The number of the the template row.
account	String	32	The Account.
object1	String	32	Dimension 1.
object2	String	32	Dimension 2.
object3	String	32	Dimension 3.
object4	String	32	Dimension 4.
object5	String	32	Dimension 5.
object6	String	32	Dimension 6.
object7	String	32	Dimension 7.
object8	String	32	Dimension 8.
quantity	Decimal	28,8	Quantity
percentage	Decimal	28,8	Percentage of the total amount to allocate on this row
userText	String	255	Free text
propertyVatAllocation	String	255
useSpecificPropVatAlloc	Int

orderId	Int
accrual	String	32
accrualRefDate	String	32
accrualRelativeStart	Int
accrualNbOfPeriods	Int
checkSignature	String	32
attestSignature	String	32
equalAmountsPerPeriod	Int
pageNumber	Int	Page to fetch. First page = 1
pageSize	Int	Number of items on each page
totalRecords	Int	Total number of records
totalPages	Int	Total pages
hasNextPage	Bool	Indicates if there is a subsequent page of results
hasPreviousPage	Bool	Indicates if there is a preceding page of results
isComplete	Bool	Indicates whether the current page is the final (or only) page.
		True when the current page number is greater than or equal to TotalPages

Reference

Post method : /api/references

This method creates a reference addressee

Inputfield	Datatype	Size	Comment
id	Int		The identifier or the reference
unitId	String	32	The identifier of the unit that the reference belongs to
text	String	255	The reference text
description	String	255	The reference description
object1	String	32	Dimension 1
object2	String	32	Dimension 2
object3	String	32	Dimension 3
object4	String	32	Dimension 4
object5	String	32	Dimension 5
object6	String	32	Dimension 6
object7	String	32	Dimension 7
object8	String	32	Dimension 8
arrivalGroup	String		Optional id of the arrival queue to send the invoice to
refAccount	String	32	Account
addressees:
addressee	String	32	User id representing the recipient to send the invoice to

Field	Datatype	Size	Comment
result	Int		Reference id of updated or created record
success	Bool		True or false to represent if the operation of update or create is successful or not
message	String	255	Summary of the operation

Get method : /api/references

This method retrieves references based on the specific request

Inputfield	Datatype	Size	Comment
UnitId	String	32	The identifier of the unit that the reference belongs to
PageNumber I	nt	Page to fetch. First page = 1
PageSize I	nt	Number of pages to get

Field	Datatype	Size	Comment
unitId	String	32	The identifier of the unit that the reference belongs to
id	String	8	The identifier of the reference
text	String	255	The reference text
description	String	255	The reference description
object1	String	32	Dimension 1
object2	String	32	Dimension 2
object3	String	32	Dimension 3
object4	String	32	Dimension 4
object5	String	32	Dimension 5
object6	String	32	Dimension 6
object7	String	32	Dimension 7
object8	String	32	Dimension 8
arrivalGroup	String	32	Optional id of the arrival queue to send the invoice to
refAccount	String	32	The reference account
addressees:
unitId	String	32	The identifier of the unit that the invoice belongs to
referenceId	Int		The identifier of reference
addressee	String	32	The Addressee
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page
totalRecords	Int		Total number of records
totalPages	Int		Total pages
hasNextPage	Bool		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
isComplete	Bool		Indicates whether the current page is the final (or only) page.
			True when the current page number is greater than or equal to TotalPages

SupplierInvoice

Get method : /api/supplier-invoices

This method retrieves the list of invoices

Inputfield	Datatype	Size	Comment
UnitId	String	8	The identifier of the unit that the invoice belongs to
SupplierId	String	32	The identifier of the supplier of the invoice
InvoiceDateFrom	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations of
			TInvoice.BookDate and TInvoice.DueDate
InvoiceDateTo	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations of TInvoice.BookDate and TInvoice.DueDate
BookDateFrom	Datetime		The bookkeeping date of the invoice to send to the external business system
BookDateTo	Datetime		The bookkeeping date of the invoice to send to the external business system
IncludeInvoiceRows	Bool		True/False
PageNumber	Int		Page to fetch. First page = 1
PageSize	Int		Number of pages to get

Field	Datatype	Size	Comment
data:
id	Int		The identifier of the invoice. This is an autogenerated number that is unique in the system over all units
unitId	String	8	The identifier of the unit that the invoice belongs to
supplierId	String	32	The identifier of the supplier of the invoice
supplierName	String	255	The name of the supplier of the invoice
amount	Decimal	28,8	The amount of the invoice
foreignAmount	Decimal	28,8	The foreign amount of the invoice
foreignVATAmount	Decimal	28,8	The foreign VAT amount of the invoice
currency	String	32	The currency of the invoice
reference	String	255	The reference of the invoice. This field is used for searching the TReference table for reference users that will receive the invoice
caseId	Int		The identifier of the workflow case assigned to the invoice. This identifier is only
			assigned once for an invoice
externalInvoiceNumber	String	32	The identifier of the invoice in the external business system
dueDate	Datetime		The due date of the invoice
invoiceDate	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations of TInvoice.BookDate and TInvoice.DueDate
arrivalDate	Datetime		The arrival date of the invoice. Depending on unit parameters this can be used
			in the calculations of TInvoice.BookDate and TInvoice.DueDate
bookDate	Datetime		The bookkeeping date of the invoice to send to the external business system
payDate	Datetime		The payment date of the invoice
importDate	Datetime		The import date of the invoice, set to the current date at the time of import. Depending on unit parameters this can be used in the calculations of TInvoice.BookDate
preliminaryBookingDate	Datetime		The date of preliminary registration in the external business system for the
			invoice
definitiveBookingDate	Datetime		The date of final registration in the external business system for the invoice
status	Int		1)
approvalSignature	String	32	If the invoice has been approved, a separate functionality in the CHECK step, this will hold the user identity of the user that has approved the invoice
assetCopy	Bool		Determines if the invoice shall pass the COPY step (1) or not (0)
blockPayment	Bool		Determines if payment shall be blocked in the external business system for the invoice (1) or not (0)
awaitCredit	Bool		Determines if the invoice shall pass the COPY step (1) or not (0)
originalInvoiceNumber	String	255	The number printed on the scanned invoice. This is used in the calculations that determine if the invoice already exists in the system or not
voucherId	String	32	The identifier of the voucher created in the external business system. This will
			be set in the preliminary and final registrations of the invoice
cancelDate	Datetime		The date of cancellation for the invoice, or NULL if the invoice has not been cancelled
payOKSignature	String	32	If the PAYOK step is used (determined by unit parameters) this will hold the
			identifier of the user that approved the payment of the invoice

secrecyInvoice	Bool		Determines if the invoice is a secrecy invoice (1) or not (0). For secrecy invoices, search access is determined by the TInvoice.SecrecyGroup identifier
watched	Bool		Determines if the invoice is watched (1) or not (0)
orderNumber	String	32	Will contain the connected order number (TOrder.Id) if the invoice has been matched against an order
kidNumber	String	255	The OCR number on the invoice. This will be sent to the external business
			system when the invoice is registered preliminary or finally
templateId	Int		If the invoice has been matched to a TInvoiceTemplate at import, this will be the identifier of that template
originalBookDate	Datetime		The bookkeeping date of the invoice at the time of preliminary registration
authorized	Bool		The invoice has been authorized in the attest or payok step
invoiceCategoryId	Int		Category of the invoice. Optional
ordermatched	Bool		Has this invoiced been ordermatched
fixedVATAmount	Int		The fixed VAT amount of the invoice
vatCurrency	String	32	The identifier of the VATCurrency of the invoice
exchangeRate	Decimal	28,8	The exchange rate of the invoice
codingReference	String	255	The coding reference of the invoice. This field is used for searching the TReference table for reference coding for the invoice
supplierInvoiceRow:
invoiceId	Int		The identifier of the invoice. This is an autogenerated number that is unique in
			the system over all units
rowNumber	Int		The row number for this row. Can be an imported value or an enumerated number starting by 1
articleId	String	32	Id of the article
supplierArticleNumber	String	32	The supplier’s article number
description	String	255	Description
quantity	Int		Quantity
quantityUnit	String	32	Unit (st, kg etc)
pricePerUnit	Decimal	28,8	The price per unit of the item ordered
amount	Decimal	28,8	Amount
discount	Decimal	28,8	Discount percentage
orderId	Int		The number of the order object connected to this row
orderRowNumber	Int		The row number of the order row connected to this row
supplierOrderNumber	String	32	The supplier order number connected to the invoice row
supplierOrderRowNumber	String	4	The supplier row number connected to this row
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page
totalRecords	Int		Total number of records
totalPages	Int		Total pages
hasNextPage	Bool		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
isComplete	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

Value	Comment
0	An imported archive invoice
1	The invoice has not yet been preliminary registered
2	The invoice has been preliminary registered
3	The invoice has been finally registered
4	The invoice has been paid
5	The invoice has been cancelled
6	The invoice has been destroyed
7	The invoice has been terminated

Get method : /api/supplier-invoices/status/{status}

This method retrieves the list of invoices by status

Inputfield	Datatype	Size	Comment
status	Int		0-7
UnitId	String	32	The identifier of the unit that the invoice belongs to
SupplierId	String	32	The identifier of the supplier of the invoice
InvoiceDateFrom	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations of TInvoice.BookDate and TInvoice.DueDate
InvoiceDateTo	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations
			of TInvoice.BookDate and TInvoice.DueDate
BookDateFrom	Datetime		The bookkeeping date of the invoice to send to the external business system
BookDateTo	Datetime		The bookkeeping date of the invoice to send to the external business system
InvoiceCategoryId	Int		Category of the invoice
IncludeAccountingRows	Bool		True/False
IncludeMessages	Bool		True/False
PageNumber	Int		Page to fetch. First page = 1
PageSize	Int		Number of pages to get

Field	Datatype	Size	Comment
data:
id	Int
supplierId	String	32	The identifier of the supplier of the invoice
supplierName	String	255	The name of the supplier of the invoice
currency	String	32	The currency of the invoice
invoiceDate	Datetime		The invoice date. Depending on unit parameters this can be used in the calculations of TInvoice.BookDate and TInvoice.DueDate
bookDate	Datetime		The bookkeeping date of the invoice to send to the external business system
definitiveBookingDate	Datetime		The date of definitive booking
invoiceCategoryId	Int		Category of the invoice
status	Int		1)
messageId	Int		The identifier in the TMessage table for the user messages for this invoice. Will
			be 0 if the invoice does not contain any user messages
originalInvoiceNumber	String	255	The number printed on the scanned invoice. This is used in the calculations that determine if the invoice already exists in the system or not
voucherId	String	32	The identifier of the voucher created in the external business system. This will
			be set in the preliminary and final registrations of the invoice
invoiceAccRows:
account	String	32	??
invoiceId	Int		The identifier of the Invoice owning this object. This is a foreign key to the Id
			column of the TInvoice table
rowNumber	Int		The number of the row within the Invoice object, starting by 1
object1	String	32	Dimension 1
object2	String	32	Dimension 2
object3	String	32	Dimension 3
object4	String	32	Dimension 4
object5	String	32	Dimension 5
object6	String	32	Dimension 6
object7	String	32	Dimension 7
object8	String	32	Dimension 8
amount	Decimal	28,8	The row amount in domestic currency
foreignAmount	Decimal	28,8	The row amount in the currency of the invoice
messages:
messageId	Int		The message id referring to the messageId on the invoice
rowNumber	Int		The row number. For each new MessageId starting on 1
messageText	String	255	The message text
creationDate	Datetime		The date at which the message was created
signature	String	32	??
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page
totalRecords	Int		Total number of records

totalPages	Int	Total pages
hasNextPage	Bool	Indicates if there is a subsequent page of results
hasPreviousPage	Bool	Indicates if there is a preceding page of results
isComplete	Bool	Indicates whether the current page is the final (or only) page.
		True when the current page number is greater than or equal to TotalPages

Value	Comment
0	An imported archive invoice
1	The invoice has not yet been preliminary registered
2	The invoice has been preliminary registered
3	The invoice has been finally registered
4	The invoice has been paid
5	The invoice has been cancelled
6	The invoice has been destroyed
7	The invoice has been terminated

Unit

Get method : /api/units

This method retrieves a list of units that are not templates with pagination support

Inputfield	Datatype	Size	Comment
pageNumber	Int		Page to fetch (1-based)
pageSize	Int	Records per page

Field	Datatype	Size	Comment
data:
id	String	32	The unique identifier for the unit (e.g., “AB1”)
name	String	255	Name of the unit
organizationNumber	String	255	The Organization number
vatNumber	String	255	The VAT number
countryCode	String	32
arrivalGroup	String	255	The arrival group name
gln	String	255	The unique identifier of the unit
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		True – more pages to fetch
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page.
			True when the current page number is greater than or equal to TotalPages

UnitParameter

Get method : /api/unit-parameter/{unitParameter-Id}

This method retrieves a specific unit parameter by its ID for a given UnitId

Inputfield	Datatype	Size	Comment
unitParameterId	String	255	The ID of the specific unit parameter (e.g., “AttestDeadlinePercentage”)
unitId	String	255	The Unit ID (e.g., “AB1”)

Field	Datatype	Size	Comment
id	String	255	The unit parameter key
value	String	255	Value of unit parameter

UnitUser

Get method : /api/unit-users

This method retrieves a list of users by unit ID with pagination support

Inputfield	Datatype	Size	Comment
unitId	String	255	Unique identifier of a Unit
pageNumber	String	255	Page to fetch. First page = 1
pageSize			Number of items on each page

Field	Datatype	Size	Comment
data:
unitId	String	32	The unique identifier for the unit (e.g., “AB1”)
userId	String	32	The unique identifier for the user (e.g., “akhusi”)
supervisor	String	32	The user id of supervisor
supervisorCopy	String	32	The user id of supervisor copy
attestAmount	Decimal		The attested financial amount
attestInvoiceAmount	Decimal		The attested amount for an invoice
codeComplObject	String	255	Object for coding supplements - Object value to be suggested when user adds accounting row
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		True – more pages to fetch
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page.
			True when the current page number is greater than or equal to TotalPages

User

Patch method : /api/im/users/supervisor

This method updates supervisor and supervisor copy

Inputfield	Datatype	Size	Comment
unitId	String	32	The identifier of the unit that the user belongs to.
userId	String	32	The users unique identifier.
Supervisor	String	32	The user id of supervisor.
supervisorCopy	String	32	The user id of supervisor copy.

Field	Datatype	Size	Comment
result	Int		User id of the updated record
success	Bool		True or false to represent if the operation of update or create is successful or not
message	String	255	Summary of the operation

Get method : /api/im/users

This method gets users from Invoice Manager

Inputfield	Datatype	Size	Comment
UserId	String	32	Unique identifier of a User.
PageSize	Int	Number of items on each page.
PageNumber	Int	Page to fetch. First page = 1

Field	Datatype	Size	Comment
data:
id	String	32	Unique User Id.
firstName	String	255	First Name of the user.
lastName	String	255	Last Name of the user.
email	String	255	Email address of the user
description	String	255	User description
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page
totalRecords	Int		Total number of records
totalPages	Int		Total pages
hasNextPage	Bool		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
isComplete	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

UserObject

Get method : /api/user-objects

This method gets all user objects with optional filtering and pagination

Inputfield	Datatype	Size	Comment
UserId	String	32	Unique identifier of a User.
UnitId	String	32	Unit identifier
ObjectTypeId	Int		The object type identifier
EffectiveDate	Date		Optional filter by effective date. Returns records where the date falls between ValidFrom and ValidTo
PageSize	Int		Number of items on each page.
PageNumber	Int		Page to fetch. First page = 1

Field	Datatype	Size	Comment
data:
unitId	String	32	The unique identifier for the unit (e.g., “AB1”)
userId	String	32	The unique identifier for the user (e.g., “akhusi”)
objectTypeId	Int	32	The object type identifier
objectValue	String	32	The object type value
attestAmount	Double		The Attest amount
validFrom	Date		User object valid from date
validTo	Date		User object valid to date
category	String	255	Row type category - search/accounting/authorization
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page.
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

Get method : /api/user-objects/search

This method gets all user objects (RowType = 0) with optional filtering and pagination

Inputfield	Datatype	Size	Comment
UserId	String	32	Unique identifier of a User.
UnitId	String	32	Unit identifier
ObjectTypeId	Int		The object type identifier
EffectiveDate	Date		Optional filter by effective date. Returns records where the date falls between ValidFrom and ValidTo
PageSize	Int		Number of items on each page.
PageNumber	Int		Page to fetch. First page = 1

Field	Datatype	Size	Comment
data:
unitId	String	32	The unique identifier for the unit (e.g., “AB1”)
userId	String	32	The unique identifier for the user (e.g., “akhusi”)
objectTypeId	Int	32	The object type identifier
objectValue	String	32	The object type value
attestAmount	Double		The Attest amount
validFrom	Date		User object valid from date
validTo	Date		User object valid to date
category	String	255	Row type category - search
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page.
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

Get method : /api/user-objects/accounting

This method gets accounting user objects (RowType = 1) with optional filtering and pagination

Inputfield	Datatype	Size	Comment
UserId	String	32	Unique identifier of a User.
UnitId	String	32	Unit identifier
ObjectTypeId	Int		The object type identifier
EffectiveDate	Date		Optional filter by effective date. Returns records where the date falls between ValidFrom and ValidTo
PageSize	Int		Number of items on each page.
PageNumber	Int		Page to fetch. First page = 1

Field	Datatype	Size	Comment
data:
unitId	String	32	The unique identifier for the unit (e.g., “AB1”)
userId	String	32	The unique identifier for the user (e.g., “akhusi”)
objectTypeId	Int	32	The object type identifier
objectValue	String	32	The object type value
attestAmount	Double		The Attest amount
validFrom	Date		User object valid from date
validTo	Date		User object valid to date
category	String	255	Row type category - accounting
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page.
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

Get method : /api/user-objects/authorization

This method gets authorization user objects (RowType = 2) with optional filtering and pagination

Inputfield	Datatype	Size	Comment
UserId	String	32	Unique identifier of a User.
UnitId	String	32	Unit identifier
ObjectTypeId	Int		The object type identifier
EffectiveDate	Date		Optional filter by effective date. Returns records where the date falls between ValidFrom and ValidTo
PageSize	Int		Number of items on each page.
PageNumber	Int		Page to fetch. First page = 1

Field	Datatype	Size	Comment
data:
unitId	String	32	The unique identifier for the unit (e.g., “AB1”)
userId	String	32	The unique identifier for the user (e.g., “akhusi”)
objectTypeId	Int	32	The object type identifier
objectValue	String	32	The object type value
attestAmount	Double		The Attest amount
validFrom	Date		User object valid from date
validTo	Date		User object valid to date
category	String	255	Row type category - authorization
pageNumber	Int		Page to fetch. First page = 1
pageSize	Int		Number of items on each page.
totalRecords	Int		Total number of records
totalPages	Int		Indicates if there is a subsequent page of results
hasPreviousPage	Bool		Indicates if there is a preceding page of results
IsCompleted	Bool		Indicates whether the current page is the final (or only) page. True when the current page number is greater than or equal to TotalPages

Post method : /api/user-objects/authorization

This method create/update authorization on user level

Inputfield	Datatype	Size	Comment
userId	String	32	The unique user identifier
unitId	String	32	The unique unit identifier
typeId	Int		The Object type identifier
objectValue	String	255	The object value
attestAmount	Double		The Attest amount
validFrom	Datetime		The valid from date
validTo	Datetime		The valid to date

Field	Datatype	Size	Comment
result	Int		User id of the updated record
success	Bool		True or false to represent if the operation of update or create is successful or not
message	String	255	Summary of the operation