AccountingConfigs
AccountingConfigs
Lists all accounting configs entries belonging to the supplied store
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a specific page in a result set.
The number of items per page in a result set.
Defines which field the resource list is sorted by.
| ENUM | Description |
|---|---|
| ASC | Sort in ascending order |
| DESC | Sort in descending order |
Response containing a list of accounting configs entries
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Response containing a list of accounting configs entries
{
"items": [
{
"accountingConfigsUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"value": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}This endpoint is mostly legacy, and for internal use. We recommend to use the other endpoints to manage accounting information
Creates a new accounting config entry for the supplied store
For configType ACCOUNTNUMBER is the following keys valid:
CUSTOMER
Account for customer
CUSTOMERDUMMY
Dummy customer account
ERROR
Error account, if no valid account is found
PARTYLYPAIDINVOICE
Account for partyly paid invoices
VATCODE
Account for a specific tax type
CASHFLOAT_DEPOSIT
Deposit cash float into the cash register
CASHFLOAT_WITHDRAWAL
Withdraw cash float from the cash register
CASHFLOAT_TO_BANK
Withdraw cash float and transfer it to the bank
CASHFLOAT_EXPENSE_WITHDRAWAL
Withdraw cash float for expenses throughout the day.
CASHFLOAT_DIFF
Account for cash register till count discrepancies
For configType TREATCODE is the following keys valid:
CREDITLEDGER
Used to credit notes
GENERALLEDGER
Used for general ledger
LEDGE
Used for invoices and other ledger
PAYMENT
Used for payment of invoices
For configType VAT_TYPE_ID is the following keys valid:
BALANCE
VATCODE
Should have a vatCodeUid filled together with the TypeID for the specific VAT code
"
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Accounting configs model
vatCodeUid should always be filled when key is of type VATCODE
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Accounting configs model
POST /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111
{
"accountingConfigUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"value": "text",
"vatCodeUid": "text"
}{
"accountingConfigsUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"vatCodeUid": "text",
"value": "text"
}Get accounting configs entry
Get accounting configs entry for the supplied accountingConfigsUid
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Accounting Configs entry.
^[A-Za-z0-9-_]+Response body containing a accounting config entry
Accounting configs model
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/{accountingConfigUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Response body containing a accounting config entry
{
"accountingConfigsUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"value": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}Update accounting config entry
Updates the accounting configs entry belonging to the supplied accountingConfigsUid
Required permissions: ACCOUNTING_CONFIG
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Accounting Configs entry.
^[A-Za-z0-9-_]+Response body containing a accounting config entry
Accounting configs model
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*PUT /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/{accountingConfigUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16
{
"value": "text"
}Response body containing a accounting config entry
{
"accountingConfigsUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"value": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}Delete accounting config entry
Deletes the accounting configs entry belonging the supplied accountingConfigsUid
Required permissions: ACCOUNTING_CONFIG
Token received from the auth service
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Accounting Configs entry.
^[A-Za-z0-9-_]+No content
DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/{accountingConfigUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Create a new productgroup account mapping
DEPRECATED use /tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/productGroups instead
Add a account number to a specific product group. This account number will be used for all products with the specified vatcode in the specific product group and all children
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Create a new account mapping to a product group
^[A-Za-z0-9-_]+accountNumber
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Response body containing a accounting config entry
Accounting configs model
^[A-Za-z0-9-_]*^[A-Za-z0-9-_]*POST /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/productGroup HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90
{
"accountingConfigUid": "text",
"value": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}Response body containing a accounting config entry
{
"accountingConfigsUid": "text",
"configType": "ACCOUNTNUMBER",
"key": "CUSTOMER",
"value": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}List all productgroups with accounting information
List all product groups with account number specified
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+The number of items per page in a result set.
Reference to a specific page in a result set.
Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/productGroups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"items": [
{
"productGroupUid": "text",
"vatCodeUid": "text",
"account": "text",
"accountingConfigUid": "text"
}
],
"paging": {
"pageNumber": 1,
"pageSize": 1,
"totalCount": 1
}
}Create a new productgroup account mapping
Add a account number to a specific product group. This account number will be used for all products with the specified vatcode in the specific product group and all children
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Create a new account mapping to a product group
^[A-Za-z0-9-_]+accountNumber
^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+^[A-Za-z0-9-_]+Account number
^[A-Za-z0-9-_]+POST /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/productGroups HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 92
{
"accountingConfigUid": "text",
"account": "text",
"vatCodeUid": "text",
"productGroupUid": "text"
}{
"productGroupUid": "text",
"vatCodeUid": "text",
"account": "text",
"accountingConfigUid": "text"
}Get all account number information
Get all account number information
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Example response
Accounting configs model
Account for customers
Error account, used if no valid account is found
Interim account for partly paid invoices.
Deposit cash float into the cash register
Withdraw cash float from the cash register
Withdraw cash float and transfer it to the bank
Withdraw cash float for expenses throughout the day
Account for cash register till count discrepancies
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/accountnumbers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"customer": "text",
"customerDummy": "text",
"error": "text",
"partlyPaidInvoice": "text",
"cashfloatDeposit": "text",
"cashfloatWithdrawal": "text",
"cashfloatToBank": "text",
"cashfloatExpenseWithdrawal": "text",
"cashfloatDiff": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"account": "text"
}
]
}Update account number information
Update account number information for a store
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Accounting configs model
Account for customers
Error account, used if no valid account is found
Interim account for partly paid invoices.
Deposit cash float into the cash register
Withdraw cash float from the cash register
Withdraw cash float and transfer it to the bank
Withdraw cash float for expenses throughout the day
Account for cash register till count discrepancies
Example response
Accounting configs model
Account for customers
Error account, used if no valid account is found
Interim account for partly paid invoices.
Deposit cash float into the cash register
Withdraw cash float from the cash register
Withdraw cash float and transfer it to the bank
Withdraw cash float for expenses throughout the day
Account for cash register till count discrepancies
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/accountnumbers HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 275
{
"customer": "text",
"customerDummy": "text",
"error": "text",
"partlyPaidInvoice": "text",
"cashfloatDeposit": "text",
"cashfloatWithdrawal": "text",
"cashfloatToBank": "text",
"cashfloatExpenseWithdrawal": "text",
"cashfloatDiff": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"account": "text"
}
]
}Example response
{
"customer": "text",
"customerDummy": "text",
"error": "text",
"partlyPaidInvoice": "text",
"cashfloatDeposit": "text",
"cashfloatWithdrawal": "text",
"cashfloatToBank": "text",
"cashfloatExpenseWithdrawal": "text",
"cashfloatDiff": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"account": "text"
}
]
}Get all treat codes
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Example response
Treat codes
Used for credit notes
Used for general ledger
Used for invoices and other ledgers
Used for payment of invoices
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/treatcodes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"creditLedger": "text",
"generalLedger": "text",
"ledger": "text",
"payment": "text"
}Update accounting treat codes for a store
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Treat codes
Used for credit notes
Used for general ledger
Used for invoices and other ledgers
Used for payment of invoices
Example response
Treat codes
Used for credit notes
Used for general ledger
Used for invoices and other ledgers
Used for payment of invoices
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/treatcodes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79
{
"creditLedger": "text",
"generalLedger": "text",
"ledger": "text",
"payment": "text"
}Example response
{
"creditLedger": "text",
"generalLedger": "text",
"ledger": "text",
"payment": "text"
}Get all VAT type
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Example response
Treat codes
VAT type used for balance transactions
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/vatTypes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"balance": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"value": "text"
}
]
}Update accounting VAT type for a store
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Treat codes
VAT type used for balance transactions
Example response
Treat codes
VAT type used for balance transactions
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/vatTypes HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"balance": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"value": "text"
}
]
}Example response
{
"balance": "text",
"vatCodes": [
{
"vatCodeUid": "text",
"value": "text"
}
]
}Customer information with accounting settings
Get customer information including store specific accounting information
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Customer.
^[A-Za-z0-9-_]+Ledger number for the customer on the specific store
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/customers/{customerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"ledgerNumber": "text"
}Update customer ledger information
Update customer with store specific accounting information.
Required permissions: ACCOUNTING_CONFIG
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Customer.
^[A-Za-z0-9-_]+Ledger number for the customer on the specific store
Ledger number for the customer on the specific store
PUT /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/customers/{customerUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"ledgerNumber": "text"
}{
"ledgerNumber": "text"
}Customer information with accounting settings
Get full customer information including store specific accounting information
Access token recevied after user login with a deviceToken
Reference to a tenant.
^[A-Za-z0-9-_]+Reference to a Store.
^[A-Za-z0-9-_]+Reference to a Customer.
^[A-Za-z0-9-_]+Example response
GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/customers/{customerUid}/full HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Example response
{
"accounting": {
"ledgerNumber": "text"
},
"customer": {
"address": "text",
"city": "text",
"companyName": "text",
"countryCode": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"customerUid": "text",
"customerParentUid": "text",
"customerType": "COMPANY",
"email": "text",
"externalId": "text",
"firstname": "text",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"lastname": "text",
"mobile": "text",
"postalCode": "text",
"pricelistUid": "text",
"vatNumber": "text",
"origin": "text",
"addresses": [
{
"address": "text",
"city": "text",
"companyName": "text",
"firstname": "text",
"lastname": "text",
"countryCode": "text",
"email": "text",
"phone": "text",
"postalCode": "text",
"type": "DELIVERY_ADDRESS",
"customerAddressUid": "text",
"displayName": "text"
}
],
"contacts": [
{
"firstname": "text",
"lastname": "text",
"email": "text",
"mobile": "text",
"createdAt": "2026-01-01T00:00:00.000Z",
"lastModifiedAt": "2026-01-01T00:00:00.000Z",
"customerContactUid": "text",
"extensions": [
{
"extensionCode": "TWO_INVOICE",
"organizationUid": "text"
}
],
"displayName": "text",
"role": "ADMIN"
}
],
"extensions": [
{
"extensionCode": "TWO_INVOICE",
"organizationUid": "text"
}
],
"consents": [
{
"consentUid": "text",
"name": "text",
"status": true,
"source": "text",
"createdAt": "2026-01-01T00:00:00.000Z"
}
],
"loyaltyId": "text",
"displayName": "text",
"credit": {
"limit": 1,
"balance": 1
},
"paymentTerms": 1,
"internalNote": "text",
"accountManager": {
"tenantUserUid": "text",
"displayName": "text",
"userCode": "text"
},
"ehfEnabled": true,
"ehf": {
"enabled": true,
"address": "text"
},
"customerGroupUids": [
"text"
],
"defaultStore": {
"name": "text",
"storeUid": "text"
},
"relevance": 1
}
}Last updated