AccountingConfigs

AccountingConfigs

List accounting configs entries

get

Lists all accounting configs entries belonging to the supplied store

Authorizations

authTokenaccessTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

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
  }
}

Create a new accounting configs entry

post

Creates a new accounting config entry for the supplied store

For configType ACCOUNTNUMBER is the following keys valid:

Key	Description
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

For configType TREATCODE is the following keys valid:

Key	Description
CREDITLEDGER
GENERALLEDGER
LEDGE

For configType VAT_TYPE_ID is the following keys valid:

Key	Description
BALANCE
VATCODE	Should have a vatCodeUid filled together with the TypeID for the specific VAT code

Authorizations

authTokenaccessTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

Body

Accounting configs model

vatCodeUid should always be filled when key is of type VATCODE

accountingConfigUidstringoptionalPattern: ^[A-Za-z0-9-_]+

configTypestring · enumrequiredAvailable options:

keystring · enumrequiredAvailable options:

valuestringrequired

vatCodeUidstringoptionalPattern: ^[A-Za-z0-9-_]+

Responses

application/json

objectoptional

Accounting configs model

post

HTTPcURLJavaScriptPython

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"
}

201Success

{
  "accountingConfigsUid": "text",
  "configType": "ACCOUNTNUMBER",
  "key": "CUSTOMER",
  "vatCodeUid": "text",
  "value": "text"
}

Get accounting configs entry

get

Get accounting configs entry for the supplied accountingConfigsUid

Authorizations

authTokenaccessTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

accountingConfigUidstringrequired

Reference to a Accounting Configs entry.

Pattern: ^[A-Za-z0-9-_]+

Responses

application/jsonapplication/xml

objectoptional

Accounting configs model

get

HTTPcURLJavaScriptPython

GET /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/{accountingConfigUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Response body containing a accounting config entry

{
  "accountingConfigsUid": "text",
  "configType": "ACCOUNTNUMBER",
  "key": "CUSTOMER",
  "value": "text",
  "vatCodeUid": "text",
  "productGroupUid": "text"
}

Update accounting config entry

put

Updates the accounting configs entry belonging to the supplied accountingConfigsUid

Authorizations

authTokenaccessTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

accountingConfigUidstringrequired

Reference to a Accounting Configs entry.

Pattern: ^[A-Za-z0-9-_]+

Body

valuestringrequired

Responses

application/jsonapplication/xml

objectoptional

Accounting configs model

put

HTTPcURLJavaScriptPython

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"
}

200

Response body containing a accounting config entry

{
  "accountingConfigsUid": "text",
  "configType": "ACCOUNTNUMBER",
  "key": "CUSTOMER",
  "value": "text",
  "vatCodeUid": "text",
  "productGroupUid": "text"
}

Delete accounting config entry

delete

Deletes the accounting configs entry belonging the supplied accountingConfigsUid

Authorizations

authTokenaccessTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

accountingConfigUidstringrequired

Reference to a Accounting Configs entry.

Pattern: ^[A-Za-z0-9-_]+

Responses

delete

HTTPcURLJavaScriptPython

DELETE /v2/tenants/{tenantUid}/stores/{storeUid}/accountingConfigs/{accountingConfigUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204Success

No Content

Create a new productgroup account mapping

post

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

Authorizations

accessTokenauthTokenintegrationToken

Path parameters

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

storeUidstringrequired

Reference to a Store.

Pattern: ^[A-Za-z0-9-_]+

Body

Create a new account mapping to a product group

accountingConfigUidstringoptionalPattern: ^[A-Za-z0-9-_]+

valuestringrequired

accountNumber

vatCodeUidstringrequiredPattern: ^[A-Za-z0-9-_]+

productGroupUidstringrequiredPattern: ^[A-Za-z0-9-_]+

Responses

application/jsonapplication/xml

objectoptional

Accounting configs model

post

HTTPcURLJavaScriptPython

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"
}

201

Response body containing a accounting config entry

{
  "accountingConfigsUid": "text",
  "configType": "ACCOUNTNUMBER",
  "key": "CUSTOMER",
  "value": "text",
  "vatCodeUid": "text",
  "productGroupUid": "text"
}