POST v1/billingstatements/BySubscription/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-05-21T08:11:02.1374814+00:00",
"endDate": "2025-05-21T08:11:02.1374814+00:00",
"trackedItemDisplay": {
"trackedItemDisplayFormat": "sample string 1",
"showTrackedItemName": {},
"showTrackedItemReference": {},
"showTrackedItemDescription": {},
"showTrackedItemCreatedDate": {}
},
"statementActivityType": "sample string 4",
"showWordStatement": true
}
Response Information
Resource Description
Common.Dto.Get.BillingStatementBySubscription| Name | Description | Type | Additional information |
|---|---|---|---|
| lineItems | Collection of Common.Dto.Get.BillingStatementBySubscriptionLineItem |
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:
{
"lineItems": [
{
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"name": "sample string 5",
"description": "sample string 6",
"reference": "sample string 7",
"lineItems": [
{
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"quantity": 5.0,
"unitPrice": 6.0,
"amount": 7.0,
"name": "sample string 8",
"description": "sample string 9",
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"endServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"rangeQuantity": 1.0,
"discounts": [
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"items": null,
"chargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
}
]
},
{
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"quantity": 5.0,
"unitPrice": 6.0,
"amount": 7.0,
"name": "sample string 8",
"description": "sample string 9",
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"endServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"rangeQuantity": 1.0,
"discounts": [
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"items": null,
"chargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
}
]
}
],
"taxes": [
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
},
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
}
],
"total": 8.0,
"unallocated": 9.0,
"allocations": [
{
"invoiceId": 1,
"invoiceNumber": 2,
"amount": 3.0
},
{
"invoiceId": 1,
"invoiceNumber": 2,
"amount": 3.0
}
],
"nameExtension": "sample string 10",
"originalActionTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"child": {
"customerId": "sample string 1",
"customerName": "sample string 2",
"companyName": "sample string 3",
"parentPayed": true
}
},
{
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"name": "sample string 5",
"description": "sample string 6",
"reference": "sample string 7",
"lineItems": [
{
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"quantity": 5.0,
"unitPrice": 6.0,
"amount": 7.0,
"name": "sample string 8",
"description": "sample string 9",
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"endServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"rangeQuantity": 1.0,
"discounts": [
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"items": null,
"chargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
}
]
},
{
"invoiceNumber": 2,
"invoiceId": 3,
"invoiceStatus": "sample string 4",
"quantity": 5.0,
"unitPrice": 6.0,
"amount": 7.0,
"name": "sample string 8",
"description": "sample string 9",
"effectiveTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"proratedUnitPrice": 1.0,
"startServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"endServiceDate": "2025-05-21T08:11:02.1374814+00:00",
"rangeQuantity": 1.0,
"discounts": [
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
},
{
"configuredDiscountAmount": 1.0,
"amount": 2.0,
"quantity": 3.0,
"unearnedAmount": 4.0,
"remainingReversalAmount": 5.0,
"discountType": "sample string 6",
"description": "sample string 7",
"id": 8,
"uri": "sample string 9"
}
],
"items": null,
"chargeTiers": [
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
},
{
"label": "sample string 1",
"quantity": 2.0,
"unitPrice": 3.0,
"amount": 4.0
}
]
}
],
"taxes": [
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
},
{
"id": 1,
"name": "sample string 1",
"registrationCode": "sample string 2",
"percent": 3.0,
"percentFormatted": "sample string 4",
"total": 5.0
}
],
"total": 8.0,
"unallocated": 9.0,
"allocations": [
{
"invoiceId": 1,
"invoiceNumber": 2,
"amount": 3.0
},
{
"invoiceId": 1,
"invoiceNumber": 2,
"amount": 3.0
}
],
"nameExtension": "sample string 10",
"originalActionTimestamp": "2025-05-21T08:11:02.1374814+00:00",
"child": {
"customerId": "sample string 1",
"customerName": "sample string 2",
"companyName": "sample string 3",
"parentPayed": true
}
}
],
"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-05-21T08:11:02.1374814+00:00",
"endDate": "2025-05-21T08:11:02.1374814+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"
}