POST v1/billingstatements/generate

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Post.BillingStatementGenerate

Name	Description	Type	Additional information
startDate		date	Required
endDate		date	Required

Request Formats

application/json, text/json

Sample:

{
  "customerId": 1,
  "startDate": "2025-11-03T19:44:34.3460058+00:00",
  "endDate": "2025-11-03T19:44:34.3460058+00:00",
  "trackedItemDisplay": {
    "trackedItemDisplayFormat": "sample string 1",
    "showTrackedItemName": {},
    "showTrackedItemReference": {},
    "showTrackedItemDescription": {},
    "showTrackedItemCreatedDate": {}
  },
  "statementActivityType": "sample string 4",
  "showWordStatement": true
}

Response Information

Resource Description

Common.Dto.Get.BillingStatement

Name	Type	Additional information
transactions	Collection of Common.Dto.Get.Transaction	None.
hierarchy	boolean	None.
header	Common.Dto.Get.BillingStatementHeader	None.
startDate	date	None.
endDate	date	None.
openingBalance	decimal number	None.
closingBalance	decimal number	None.
currency	string	None.
accountBillingStatementPreference	Common.Dto.Get.AccountBillingStatementPreference	None.
option	string	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "transactions": [
    {
      "effectiveTimestamp": "2025-11-03T19:44:34.3460058+00:00",
      "transactionType": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "reference": "sample string 5",
      "arDebit": 6.0,
      "arCredit": 7.0,
      "runningTotal": 8.0,
      "associatedId": 1,
      "productItems": null,
      "child": {
        "customerId": "sample string 1",
        "customerName": "sample string 2",
        "companyName": "sample string 3",
        "parentPayed": true
      },
      "id": 9,
      "uri": "sample string 10"
    },
    {
      "effectiveTimestamp": "2025-11-03T19:44:34.3460058+00:00",
      "transactionType": "sample string 2",
      "name": "sample string 3",
      "description": "sample string 4",
      "reference": "sample string 5",
      "arDebit": 6.0,
      "arCredit": 7.0,
      "runningTotal": 8.0,
      "associatedId": 1,
      "productItems": null,
      "child": {
        "customerId": "sample string 1",
        "customerName": "sample string 2",
        "companyName": "sample string 3",
        "parentPayed": true
      },
      "id": 9,
      "uri": "sample string 10"
    }
  ],
  "hierarchy": true,
  "header": {
    "signature": "sample string 1",
    "customer": {
      "fullName": "sample string 1",
      "companyName": "sample string 2",
      "billingAddress": {
        "customerAddressPreferenceId": 1,
        "companyName": "sample string 2",
        "line1": "sample string 3",
        "line2": "sample string 4",
        "countryId": 1,
        "country": "sample string 5",
        "stateId": 1,
        "state": "sample string 6",
        "city": "sample string 7",
        "postalZip": "sample string 8",
        "addressType": "sample string 9",
        "valid": true,
        "id": 11,
        "uri": "sample string 12"
      }
    },
    "customerReferenceValue": "sample string 2",
    "showWordStatement": true
  },
  "startDate": "2025-11-03T19:44:34.3460058+00:00",
  "endDate": "2025-11-03T19:44:34.3460058+00:00",
  "openingBalance": 4.0,
  "closingBalance": 5.0,
  "currency": "sample string 6",
  "accountBillingStatementPreference": {
    "option": "sample string 1",
    "type": "sample string 2",
    "interval": "sample string 3",
    "day": 1,
    "month": 1,
    "trackedItemDisplayFormat": "sample string 4",
    "showTrackedItemName": true,
    "showTrackedItemReference": true,
    "showTrackedItemDescription": true,
    "showTrackedItemCreatedDate": true,
    "trackedItemNameFieldOverride": "sample string 9",
    "trackedItemReferenceFieldOverride": "sample string 10",
    "trackedItemDescriptionFieldOverride": "sample string 11",
    "trackedItemCreatedDateFieldOverride": "sample string 12",
    "trackedItemPageLabelOverride": "sample string 13",
    "trackedItemMainInvoiceMessage": "sample string 14",
    "statementActivityType": "sample string 15",
    "showServiceDates": true,
    "showWordStatement": true,
    "id": 18,
    "uri": "sample string 19"
  },
  "option": "sample string 7",
  "id": 8,
  "uri": "sample string 9"
}