Web-Regnskab API v1 Documentation

Web-Regnskab API is a JSON-based REST API. It allows you to perform all the operations that you do with our web clients.

If you have any questions or feedback, please don't hesitate to mail us at dev@web-regnskab.dk.

We suggest the following steps:

Endpoint
The API is located at https://api.web-regnskab.dk/v1.
All requests must use SSL.

Rate limit:
Currently, you may make up to 10 requests per second to our endpoint and up to 5000 requests per 24-hour window.
Access tokens

Here's how to obtain an access token for your company:
- Ask our support to turn on API for your company
- Log into your account. Go to Settings -> General Setup
- Click Add to create a new token. Enter a descriptive name for your token, so you can easily identify it later. Then hit the Save button.
Using access token
All you have to do now is put this token in a X-API-KEY header
The tokens you create above are tied to that company only. If you have multiple companies, you'll need a separate token for each one. Tokens are permanent.

Prospect entity:

Attribute

Property	Type	Description
`ProspectID`	integer	ID of the prospect. It is primary key
`CustomerName`	string	Customer name. Max-length [100]. Required
`CustomerNumber`	string	Max-length [20]
`RegistrationNumber`	string	Max-length [50]
`Address1`	string	Max-length [250]
`Address2`	string	Max-length [250]
`Zipcode`	string	Max-length [20]
`City`	string	Max-length [100]
`State`	string	Max-length [20]
`CountryID`	integer	Foreign key
`PhoneNumber`	string	Max-length [50]
`FaxNumber`	string	Max-length [50]
`Website`	string	Max-length [150]
`Email`	string	Max-length [100]
`TypeID`	integer	Prospect's type. It is foreign key
`StatusID`	integer	Prospect's status. It is foreign key
`ProspectOwnerID`	guid	ID of the user who owns this prospect. Required
`GeneralField`	string	Max-length [250]
`LeadSource`	string	Max-length [100]
`FreeTextField`	string	Max-length [500]

Get a prospect
Retrieves prospect's information for the given id. You should use GET /v1/prospects/:id (where :id should be replaced by a real prospect's ID).
The response will be a JSON document, below is an example:
```
          
{
  "ProspectID": 19899,
  "CustomerName": "AdviceCo",
  ...                 
}
                    
                  
```
Delete a prospect
Use DELETE /v1/prospects/:id (where :id should be replaced by a real prospect's ID).
Returns 200 (OK) if the prospect is deleted successfully

Add a new prospect to the organization

Use POST /v1/prospects

Requests Formats

          
{
  "CustomerName": "AdviceCo",
  "CustomerNumber": "VIP2970",
  "RegistrationNumber": "123456",
  "CountryID": 60,
  "PhoneNumber": "123456789",
  "Email": "test@test.com"
}

If the prospect created sucessfully, you will get the ID of the newly created prospect in the returned JSON

          
{
  "ProspectID": 12789
}

Update an existing prospect

Use PUT /v1/prospects/:id (where :id should be replaced by a real prospect's ID)

Requests Formats

          
{
  "CustomerName": "AdviceCo",
  "CustomerNumber": "VIP2970",
  "RegistrationNumber": "123456",
  "CountryID": 60,
  "PhoneNumber": "123456789",
  "Email": "test@test.com"
}

Returns 200 (OK) if the prospect is updated successfully

Search for prospects
Use GET /v1/prospects?searchCriteria=search_term&page=1&pageSize=100&orderBy=CustomerName&ascending=true
Notes:
- search_term: is the value you want to filter on. If left empty no filtering is applied
- page: is page index. Default is 1 if not specified
- pageSize: is The maximum number of items to include in a page. Default is 100 if not specified
- orderBy: It is the column you want to sort on. Default is ProspectID if not specified
- ascending: true is Ascending order. false is descending order. Default is Ascending if not specified
The response will be a JSON document, below is an example:
```
          
{
  "PageIndex":1,
  "PageSize":100,
  "TotalNumberOfPages":1,
  "TotalNumberOfRecords":70
  "Results": [
    {
      "ProspectID": 19899,
      "CustomerName": "AdviceCo",
      ...                
    },
    {
      "ProspectID": 21239,
      "CustomerName": "Polinte",
      ...                
    }                      
  ]
}
                    
                  
```

Invoice entity:

Attribute

Property Type Description

ProspectID integer ID of the prospect the invoice has to be created. If not given (or zero), the prospect automatically created.

CustomerName string Customer name. Max-length [100]. Required

CompanyRegNo string Customer name. Max-length [100].

Address1 string Max-length [250]. Required

Address2 string Max-length [250]

Zipcode string Max-length [20]

City string Max-length [100]

State string Max-length [20]

CountryID integer Foreign key

Attention string The contact name related to the invoice. Max-length [150]

InvoiceDate date Invoice's date. Required

LanguageID integer The language ID of the PDF template. It is foreign key

PaymentTerms integer Payment terms in days. The due date will be calculated based on this

OurREF guid ID of the sale person.

PurchaseOrderNo string Purchase order number for reference. Max-length [50]

OurPONo string Our Purchase order number. Max-length [50]

EANNumber string EAN number. Max-length [50]

VATRate decimal Invoice's VAT. Required

Text string Max-length [500]

RecipientEmails string List of receivers's emails that are separated by comma. Max-length [500]

ActivityReminderDays integer An activity automatically created if this value given.

CreatedByUserId guid ID of the user who creates this invoice. Required

Currency string Currency code. 3 characters

ExchangeRate decimal Exchange rate of the currency

IsDraft boolean True if you want to create a draft invoice.

PostAtAccountID integer The ID of account that invoice will be posted to. It is foreign key. Required

InvoiceDetails

array

This is array of items. Required.

`ProductID`	integer	The ID of the product. If not given, system automatically use product's number
`ProductNumber`	string	Max-length [50]
`ProductName`	string	Max-length [300]
`Qty`	decimal	Required
`Price`	decimal	Required

Add a new invoice

Use POST /v1/invoices

Requests Formats

          
{
  "ProspectID": 180,
  //If ProspectID not given, or ProspectID = 0, System automatically create new customer
  //from following info: CustomerName, Email, PhoneNumber, Address. CustomerName and Address 
  //are required to create invoice
  "CustomerName": "AdviceCo",
  "InvoiceDate": "2019-07-01",
  "PaymentTerms": 7,
  //If the PostAtAccountID not specified, they can give PostAtAccountNumber - for ex: 1001
  "PostAtAccountID": 8989, 
  ...,
  //If the PaidAccountNumber given, system automatically mark the invoice as paid
  //for this account number 
  "PaidAccountNumber": 2401, 
  "InvoiceDetails": [
    {
      //If ProductID not specified, they can give ProductNumber - for ex: PN0001
      "ProductID": 19899, 
      "ProductName": "product name 1",
      "Qty": 1.5,
      "Price": 300,
      "UnitName": "unit"
      ...                
    },
    {
      "ProductID": 21899,
      "ProductName": "product name 2",
      "Qty": 1,
      "Price": 450,
      "UnitName": "unit"
      ...                
    }                      
  ]
}

If the invoice created sucessfully, you will get the ID of the newly created invoice in the returned JSON

          
{
  "InvoiceID": 1000
}

Search for invoices
Use GET /v1/invoices?searchCriteria=search_term&page=1&pageSize=100&orderBy=InvoiceNumber&ascending=false
Notes:
- search_term: is the value you want to filter on. If left empty no filtering is applied. Noted that: Currently, it searchs on invoice number(s), for ex: 1234, 2345
- page: is page index. Default is 1 if not specified
- pageSize: is The maximum number of items to include in a page. Default is 100 if not specified
- orderBy: It is the column you want to sort on. Default is InvoiceNumber if not specified
- ascending: true is Ascending order. false is descending order. Default is Descending if not specified
The response will be a JSON document, below is an example:
```
          
{
  "PageIndex":1,
  "PageSize":100,
  "TotalNumberOfPages":1,
  "TotalNumberOfRecords":70
  "Results": [
    {
      "InvoiceID": 19899,
      "InvoiceNumber": 120,
      "CustomerName": "AdviceCo",
      ...                
    },
    {
      "InvoiceID": 21239,
      "InvoiceNumber": 121,
      "CustomerName": "Polinte",
      ...                
    }                      
  ]
}
                    
                  
```

Product entity:

Attribute

Property	Type	Description
`ProductID`	integer	ID of the product. It is primary key
`ProductNumber`	string	Max-length [50]
`ProductName`	string	Max-length [300]. Required.
`ProductGroupID`	integer	Foreign key. Required.
`VATRate`	decimal	Product's VAT. Required.
`StockQty`	decimal	Product's stock quantity
`SalePriceExclVAT`	decimal	Product's sale price. Required.
`CostPrice`	decimal	Product's purchase price.
`PostToAccountID`	integer	The ID of account that product will be posted to when invoicing. Foreign key.

Get a product

Retrieves product item for the given id. You should use GET /v1/products/:id (where :id should be replaced by a real product's ID).
The response will be a JSON document, below is an example:

          
{
  "ProductID": 12234,
  "ProductNumber": "P0001",
  "ProductName": "Hard Drive",
  ...                 
}

Delete a product
Use DELETE /v1/products/:id (where :id should be replaced by a real product's ID).
Returns 200 (OK) if the product is deleted successfully

Add a new product

Use POST /v1/products

Requests Formats

          
{
  "ProductNumber": "P0001",
  "ProductName": "Laptop Lenovo",
  "ProductGroupID": 60,
  "VATRate": "25.0",
  "SalePriceExclVAT": "1200.45",
  "StockQty": "10",
  "CostPrice": "1000"
}

If the product created sucessfully, you will get the ID of the newly created product in the returned JSON

          
{
  "ProductID": 124789
}

Update an existing product

Use PUT /v1/products/:id (where :id should be replaced by a real product's ID)

Requests Formats

          
{
  "ProductNumber": "P0001",
  "ProductName": "Laptop Lenovo",
  "ProductGroupID": 60,
  "VATRate": "25.0",
  "SalePriceExclVAT": "1200.45",
  "StockQty": "10",
  "CostPrice": "1000"
}

Returns 200 (OK) if the product is updated successfully

Journal entity:

Attribute

Property	Type	Description
`PostingDate`	date	The date on which the journal to be recorded. Required
`Amount`	decimal	The journal's amount. Required
`DebitCredit`	character	'D' = Debit, 'C' = Credit. Required.
`AccountNumber`	integer	The account number. Required.
`ReverseAccountNumber`	integer	The reverseaccount number.
`VATAmount`	decimal	VAT amount.
`Description`	string	Notes for the journal.

Add a new journal

Use POST /v1/journals

Requests Formats

          
{
  "PostingDate": "2020-01-15",
  "Amount": 1200,
  "DebitCredit": "D",
  "AccountNumber": 1201,
  "ReverseAccountNumber": 2401,
  "Description": "Loan payment"
}

If the journal created sucessfully, you will get the reference number in the returned JSON

          
{                      
  "TransactionNumber": 225
}

CustomerPayment entity:

Attribute

Property	Type	Description
`InvoiceID`	integer	The invoice's ID. Required
`PaidDate`	date	The date on which the invoice was paid. Required
`Amount`	decimal	The paid amount. Required
`BankAccountNumber`	integer	The account number that the amount was deposited to. Required.

Posting a payment for an invoice by invoice's id or invoice's number

Use POST /v1/customerpayments

Requests Formats - Invoice ID

          
{
  "InvoiceID": 1345798,
  "PaidDate": "2020-01-15",
  "Amount": 1200,
  "BankAccountNumber": 2401
}

Requests Formats - Invoice Number

          
{
  "InvoiceNumber": 1208,
  "PaidDate": "2020-01-15",
  "Amount": 1200,
  "BankAccountNumber": 2401
}

If the payment created sucessfully, you will get the reference number in the returned JSON

          
{                      
  "TransactionNumber": 120
}

Account entity:

Attribute

Property	Type	Description
`AccountNumber`	integer	Account number e.g. 1000.
`AccountName`	string	Max-length [250]. Required.
`VATCode`	integer	The VAT code of the account

Get chart of accounts

Fetch the chart of accounts for the organization. You should use GET /v1/accounts.
The response will be a JSON document, below is an example:

            
              [
                {
                "AccountNumber": 1001,
                "AccountName": "Sales - Goods",
                "VATCode": ""
                },
                {
                "AccountNumber": 1002,
                "AccountName": "Sales - Others",
                "VATCode": "S1"
                },
                ...
              ]

We suggest the following steps:

Endpoint

Access tokens

Using access token

Prospect entity:

Attribute

Get a prospect

Delete a prospect

Add a new prospect to the organization

Update an existing prospect

Search for prospects

Invoice entity:

Attribute

Add a new invoice

Search for invoices

Product entity:

Attribute

Get a product

Delete a product

Add a new product

Update an existing product

Journal entity:

Attribute

Add a new journal

CustomerPayment entity:

Attribute

Posting a payment for an invoice by invoice's id or invoice's number

Account entity:

Attribute

Get chart of accounts