Example config JSON

The following is an example of a configuration file returned by the /company/{companyId}/config endpoint with options for selected accounts and tax rates previously set.

{
  "companyId": "48ab6e43-66b7-4a6e-9e94-4df6ed267996",
  "accountingSoftwareCompanyName": "Pete's Pies",
  "enabled": true,
  "schedule": {
    "selectedFrequency": "daily",
    "frequencyOptions": [
      "daily"
    ],
    "startDate": "2019-01-22T11:27:55.086Z",
    "syncHourUtc": 0
  },
  "configuration": {
    "sales": {
      "syncSales": true,
      "accounts": {
        "sales": {
          "labelText": "Sales",
          "descriptionText": "The account to record your sales against.",
          "selectedAccountId": "1234",
          "accountOptions": [
            {
              "name": "POS Sales",
              "id": "1234",
              "classification": "nominal" 
            }
          ]
        },
        "refund": {
          "labelText": "Refunds",
          "descriptionText": "The account to record refunds against.",
          "selectedAccountId": "5678",
          "accountOptions": [
            {
              "name": "Refunds",
              "id": "5678",
              "classification": "nominal"
            }
          ]
        }
      },
      "invoiceStatus": {
        "selectedInvoiceStatus": "draft",
        "invoiceStatusOptions": [
          "draft", "submitted", "paid"
        ]
      },
      "salesCustomer": {
        "selectedCustomerId": "9876",
        "customerOptions": [
          {
            "name": "Default Customer",
            "id": "9876"
          }
        ]
      },
      "taxRates": {
        "10": {
          "selectedTaxRateId": "7766",
          "taxRateOptions": [
            {
              "name": "10% Local Tax",
              "id": "7766"
            }
          ]
        },
        "15": {
          "selectedTaxRateId": "3456",
          "taxRateOptions": [
            {
              "name": "15% State Tax",
              "id": "3456"
            }
          ]
        },
        "17.5": {
          "selectedTaxRateId": "6789",
          "taxRateOptions": [
            {
              "name": "17.5% Sales Tax",
              "id": "6789"
            }
          ]
        }
      },
      "grouping": {
        "groupingPeriod": {
          "selectedGroupingPeriod": "daily",
          "groupingPeriodOptions": [
            "daily"
          ]
        },
        "groupingLevels": {
          "invoiceLevel": {
            "selectedGroupByOptions": [],
            "groupByOptions": []
          },
          "invoiceLineLevel": {
            "selectedGroupByOptions": [],
            "groupByOptions": []
          }
        }
      }
    },
    "payments": {
      "syncPayments": true,
      "accounts": {
        "cash": {
          "labelText": "Cash",
          "descriptionText": "The account you wish to record your cash payments to.",
          "selectedAccountId": "string",
          "accountOptions": [
            {
              "name": "string",
              "id": "string",
              "classification": "nominal"
            }
          ]
        },
        "card": {
          "labelText": "Card",
          "descriptionText": "The account you wish to record your card payments to.",
          "selectedAccountId": "4589",
          "accountOptions": [
            {
              "name": "Card Payments",
              "id": "4589",
              "classification": "bank"
            },
            {
              "name": "Card Transactions",
              "id": "4590",
              "classification": "bank"
            }
          ]
        },
        "paypal": {
          "labelText": "PayPal",
          "descriptionText": "The account you wish to record your PayPal payments to.",
          "selectedAccountId": "8743",
          "accountOptions": [
            {
              "name": "string",
              "id": "8743",
              "classification": "nominal"
            }
          ]
        }
      }
    },
    "fees": {
      "syncFees": true,
      "accounts": {
        "fees": {
          "labelText": "Fees",
          "descriptionText": "The account you wish to synchronise your fees with. ",
          "selectedAccountId": "1991",
          "accountOptions": [
            {
              "name": "Commerce Fees",
              "id": "1991",
              "classification": "nominal"
            }
          ]
        }
      }
    }
  }
}

Did this page help you?