AccountingConfigs
AccountingConfigs
Lists all accounting configs entries belonging to the supplied store
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
}
}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
For configType TREATCODE is the following keys valid:
CREDITLEDGER
GENERALLEDGER
LEDGE
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
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-_]+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
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
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
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
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
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
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
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
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"
}Was this helpful?