POST v1/BillingPeriodDefinitions/Preview
Documentation for 'Preview'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
entity | Documentation for 'entity'. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
Click to beautify!
{ "customerId": 1, "interval": "sample string 2", "numberOfIntervals": 3, "invoiceDay": 4, "invoiceMonth": 1, "invoiceInAdvance": 5, "manuallyCreated": true, "paymentMethodId": 1, "autoCollect": true, "autoPost": true, "term": "sample string 7", "poNumber": "sample string 8" }
application/x-www-form-urlencoded
Sample:
Click to beautify!
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "currentBillingPeriodStartDate": "2024-05-03T06:40:21.8722768+00:00", "currentBillingPeriodEndDate": "2024-05-03T06:40:21.8722768+00:00", "nextRechargeDate": "2024-05-03T06:40:21.8722768+00:00", "invoiceDay": 1, "invoiceMonth": 1, "cycle": "sample string 1", "billingPeriodType": "sample string 2", "createdDate": "2024-05-03T06:40:21.8722768+00:00", "numberOfIntervals": 3, "numberOfBillingPeriods": 4, "invoiceInAdvance": 5, "manuallyCreated": true, "paymentMethodId": 1, "autoCollect": true, "autoPost": true, "term": "sample string 7", "poNumber": "sample string 8", "subscriptions": { "headers": { "count": 1, "currentPage": 2, "previousPage": 3, "nextPage": 4, "maxCount": 5, "pageSize": 6, "maxPageIndex": 7, "sortExpression": "sample string 8", "sortOrder": "sample string 9", "additionalData": "sample string 10" }, "results": [ { "customerId": 1, "planId": 2, "planCode": "sample string 3", "name": "sample string 4", "description": "sample string 5", "reference": "sample string 6", "interval": "sample string 7", "numberOfInterval": 1, "subscriptionStatus": "sample string 8", "monthlyRecurringRevenue": 9.0, "netMonthlyRecurringRevenue": 10.0, "lastBillingDate": "2024-05-03T06:40:21.8722768+00:00", "nextBillingDate": "2024-05-03T06:40:21.8879096+00:00", "expiryDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledActivationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "cancellationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "suspendedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "createdTimestamp": "2024-05-03T06:40:21.8879096+00:00", "modifiedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "activatedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "provisionedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "nextPeriodStartDate": "2024-05-03T06:40:21.8879096+00:00", "contractStartTimestamp": "2024-05-03T06:40:21.8879096+00:00", "contractEndTimestamp": "2024-05-03T06:40:21.8879096+00:00", "remainingInterval": 1, "migrationDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledMigrationDate": "2024-05-03T06:40:21.8879096+00:00", "canMigrate": true, "customerFirstName": "sample string 14", "customerLastName": "sample string 15", "customerReference": "sample string 16", "companyName": "sample string 17", "customerParentId": 1, "currency": "sample string 18", "invoiceOwner": "sample string 19", "invoiceOwnerId": 20, "geotabDevicePlanId": 1, "geotabDevicePlanName": "sample string 21", "customerIsParent": true, "accountingStatus": "sample string 23", "customerStatus": "sample string 24", "customerMiddleName": "sample string 25", "customerSuffix": "sample string 26", "customerTitle": "sample string 27", "id": 28, "uri": "sample string 29" }, { "customerId": 1, "planId": 2, "planCode": "sample string 3", "name": "sample string 4", "description": "sample string 5", "reference": "sample string 6", "interval": "sample string 7", "numberOfInterval": 1, "subscriptionStatus": "sample string 8", "monthlyRecurringRevenue": 9.0, "netMonthlyRecurringRevenue": 10.0, "lastBillingDate": "2024-05-03T06:40:21.8722768+00:00", "nextBillingDate": "2024-05-03T06:40:21.8879096+00:00", "expiryDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledActivationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "cancellationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "suspendedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "createdTimestamp": "2024-05-03T06:40:21.8879096+00:00", "modifiedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "activatedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "provisionedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "nextPeriodStartDate": "2024-05-03T06:40:21.8879096+00:00", "contractStartTimestamp": "2024-05-03T06:40:21.8879096+00:00", "contractEndTimestamp": "2024-05-03T06:40:21.8879096+00:00", "remainingInterval": 1, "migrationDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledMigrationDate": "2024-05-03T06:40:21.8879096+00:00", "canMigrate": true, "customerFirstName": "sample string 14", "customerLastName": "sample string 15", "customerReference": "sample string 16", "companyName": "sample string 17", "customerParentId": 1, "currency": "sample string 18", "invoiceOwner": "sample string 19", "invoiceOwnerId": 20, "geotabDevicePlanId": 1, "geotabDevicePlanName": "sample string 21", "customerIsParent": true, "accountingStatus": "sample string 23", "customerStatus": "sample string 24", "customerMiddleName": "sample string 25", "customerSuffix": "sample string 26", "customerTitle": "sample string 27", "id": 28, "uri": "sample string 29" }, { "customerId": 1, "planId": 2, "planCode": "sample string 3", "name": "sample string 4", "description": "sample string 5", "reference": "sample string 6", "interval": "sample string 7", "numberOfInterval": 1, "subscriptionStatus": "sample string 8", "monthlyRecurringRevenue": 9.0, "netMonthlyRecurringRevenue": 10.0, "lastBillingDate": "2024-05-03T06:40:21.8722768+00:00", "nextBillingDate": "2024-05-03T06:40:21.8879096+00:00", "expiryDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledActivationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "cancellationTimestamp": "2024-05-03T06:40:21.8879096+00:00", "suspendedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "createdTimestamp": "2024-05-03T06:40:21.8879096+00:00", "modifiedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "activatedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "provisionedTimestamp": "2024-05-03T06:40:21.8879096+00:00", "nextPeriodStartDate": "2024-05-03T06:40:21.8879096+00:00", "contractStartTimestamp": "2024-05-03T06:40:21.8879096+00:00", "contractEndTimestamp": "2024-05-03T06:40:21.8879096+00:00", "remainingInterval": 1, "migrationDate": "2024-05-03T06:40:21.8879096+00:00", "scheduledMigrationDate": "2024-05-03T06:40:21.8879096+00:00", "canMigrate": true, "customerFirstName": "sample string 14", "customerLastName": "sample string 15", "customerReference": "sample string 16", "companyName": "sample string 17", "customerParentId": 1, "currency": "sample string 18", "invoiceOwner": "sample string 19", "invoiceOwnerId": 20, "geotabDevicePlanId": 1, "geotabDevicePlanName": "sample string 21", "customerIsParent": true, "accountingStatus": "sample string 23", "customerStatus": "sample string 24", "customerMiddleName": "sample string 25", "customerSuffix": "sample string 26", "customerTitle": "sample string 27", "id": 28, "uri": "sample string 29" } ] }, "paymentSchedules": [ { "amount": 1.0, "daysDueAfterTerm": 2 }, { "amount": 1.0, "daysDueAfterTerm": 2 }, { "amount": 1.0, "daysDueAfterTerm": 2 } ], "id": 9, "uri": "sample string 10" }
application/xml, text/xml
Sample:
Click to beautify!
<BillingPeriodDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get"> <Id>9</Id> <Uri>sample string 10</Uri> <AutoCollect>true</AutoCollect> <AutoPost>true</AutoPost> <BillingPeriodType>sample string 2</BillingPeriodType> <CreatedDate>2024-05-03T06:40:21.8722768+00:00</CreatedDate> <CurrentBillingPeriodEndDate>2024-05-03T06:40:21.8722768+00:00</CurrentBillingPeriodEndDate> <CurrentBillingPeriodStartDate>2024-05-03T06:40:21.8722768+00:00</CurrentBillingPeriodStartDate> <Cycle>sample string 1</Cycle> <InvoiceDay>1</InvoiceDay> <InvoiceInAdvance>5</InvoiceInAdvance> <InvoiceMonth>1</InvoiceMonth> <ManuallyCreated>true</ManuallyCreated> <NextRechargeDate>2024-05-03T06:40:21.8722768+00:00</NextRechargeDate> <NumberOfBillingPeriods>4</NumberOfBillingPeriods> <NumberOfIntervals>3</NumberOfIntervals> <PaymentMethodId>1</PaymentMethodId> <PaymentSchedules> <BillingPeriodPaymentSchedule> <Amount>1</Amount> <DaysDueAfterTerm>2</DaysDueAfterTerm> </BillingPeriodPaymentSchedule> <BillingPeriodPaymentSchedule> <Amount>1</Amount> <DaysDueAfterTerm>2</DaysDueAfterTerm> </BillingPeriodPaymentSchedule> <BillingPeriodPaymentSchedule> <Amount>1</Amount> <DaysDueAfterTerm>2</DaysDueAfterTerm> </BillingPeriodPaymentSchedule> </PaymentSchedules> <PoNumber>sample string 8</PoNumber> <Subscriptions> <PagingHeaderData> <AdditionalData>sample string 10</AdditionalData> <Count>1</Count> <CurrentPage>2</CurrentPage> <MaxCount>5</MaxCount> <MaxPageIndex>7</MaxPageIndex> <NextPage>4</NextPage> <PageSize>6</PageSize> <PreviousPage>3</PreviousPage> <SortExpression>sample string 8</SortExpression> <SortOrder>sample string 9</SortOrder> </PagingHeaderData> <Results> <SubscriptionSummary> <Id>28</Id> <Uri>sample string 29</Uri> <AccountingStatus>sample string 23</AccountingStatus> <ActivatedTimestamp>2024-05-03T06:40:21.8879096+00:00</ActivatedTimestamp> <CanMigrate>true</CanMigrate> <CancellationTimestamp>2024-05-03T06:40:21.8879096+00:00</CancellationTimestamp> <CompanyName>sample string 17</CompanyName> <ContractEndTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractEndTimestamp> <ContractStartTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractStartTimestamp> <CreatedTimestamp>2024-05-03T06:40:21.8879096+00:00</CreatedTimestamp> <Currency>sample string 18</Currency> <CustomerFirstName>sample string 14</CustomerFirstName> <CustomerId>1</CustomerId> <CustomerIsParent>true</CustomerIsParent> <CustomerLastName>sample string 15</CustomerLastName> <CustomerMiddleName>sample string 25</CustomerMiddleName> <CustomerParentId>1</CustomerParentId> <CustomerReference>sample string 16</CustomerReference> <CustomerStatus>sample string 24</CustomerStatus> <CustomerSuffix>sample string 26</CustomerSuffix> <CustomerTitle>sample string 27</CustomerTitle> <Description>sample string 5</Description> <ExpiryDate>2024-05-03T06:40:21.8879096+00:00</ExpiryDate> <GeotabDevicePlanId>1</GeotabDevicePlanId> <GeotabDevicePlanName>sample string 21</GeotabDevicePlanName> <Interval>sample string 7</Interval> <InvoiceOwner>sample string 19</InvoiceOwner> <InvoiceOwnerId>20</InvoiceOwnerId> <LastBillingDate>2024-05-03T06:40:21.8722768+00:00</LastBillingDate> <MigrationDate>2024-05-03T06:40:21.8879096+00:00</MigrationDate> <ModifiedTimestamp>2024-05-03T06:40:21.8879096+00:00</ModifiedTimestamp> <MonthlyRecurringRevenue>9</MonthlyRecurringRevenue> <Name>sample string 4</Name> <NetMonthlyRecurringRevenue>10</NetMonthlyRecurringRevenue> <NextBillingDate>2024-05-03T06:40:21.8879096+00:00</NextBillingDate> <NextPeriodStartDate>2024-05-03T06:40:21.8879096+00:00</NextPeriodStartDate> <NumberOfInterval>1</NumberOfInterval> <PlanCode>sample string 3</PlanCode> <PlanId>2</PlanId> <ProvisionedTimestamp>2024-05-03T06:40:21.8879096+00:00</ProvisionedTimestamp> <Reference>sample string 6</Reference> <RemainingInterval>1</RemainingInterval> <ScheduledActivationTimestamp>2024-05-03T06:40:21.8879096+00:00</ScheduledActivationTimestamp> <ScheduledMigrationDate>2024-05-03T06:40:21.8879096+00:00</ScheduledMigrationDate> <SubscriptionStatus>sample string 8</SubscriptionStatus> <SuspendedTimestamp>2024-05-03T06:40:21.8879096+00:00</SuspendedTimestamp> </SubscriptionSummary> <SubscriptionSummary> <Id>28</Id> <Uri>sample string 29</Uri> <AccountingStatus>sample string 23</AccountingStatus> <ActivatedTimestamp>2024-05-03T06:40:21.8879096+00:00</ActivatedTimestamp> <CanMigrate>true</CanMigrate> <CancellationTimestamp>2024-05-03T06:40:21.8879096+00:00</CancellationTimestamp> <CompanyName>sample string 17</CompanyName> <ContractEndTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractEndTimestamp> <ContractStartTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractStartTimestamp> <CreatedTimestamp>2024-05-03T06:40:21.8879096+00:00</CreatedTimestamp> <Currency>sample string 18</Currency> <CustomerFirstName>sample string 14</CustomerFirstName> <CustomerId>1</CustomerId> <CustomerIsParent>true</CustomerIsParent> <CustomerLastName>sample string 15</CustomerLastName> <CustomerMiddleName>sample string 25</CustomerMiddleName> <CustomerParentId>1</CustomerParentId> <CustomerReference>sample string 16</CustomerReference> <CustomerStatus>sample string 24</CustomerStatus> <CustomerSuffix>sample string 26</CustomerSuffix> <CustomerTitle>sample string 27</CustomerTitle> <Description>sample string 5</Description> <ExpiryDate>2024-05-03T06:40:21.8879096+00:00</ExpiryDate> <GeotabDevicePlanId>1</GeotabDevicePlanId> <GeotabDevicePlanName>sample string 21</GeotabDevicePlanName> <Interval>sample string 7</Interval> <InvoiceOwner>sample string 19</InvoiceOwner> <InvoiceOwnerId>20</InvoiceOwnerId> <LastBillingDate>2024-05-03T06:40:21.8722768+00:00</LastBillingDate> <MigrationDate>2024-05-03T06:40:21.8879096+00:00</MigrationDate> <ModifiedTimestamp>2024-05-03T06:40:21.8879096+00:00</ModifiedTimestamp> <MonthlyRecurringRevenue>9</MonthlyRecurringRevenue> <Name>sample string 4</Name> <NetMonthlyRecurringRevenue>10</NetMonthlyRecurringRevenue> <NextBillingDate>2024-05-03T06:40:21.8879096+00:00</NextBillingDate> <NextPeriodStartDate>2024-05-03T06:40:21.8879096+00:00</NextPeriodStartDate> <NumberOfInterval>1</NumberOfInterval> <PlanCode>sample string 3</PlanCode> <PlanId>2</PlanId> <ProvisionedTimestamp>2024-05-03T06:40:21.8879096+00:00</ProvisionedTimestamp> <Reference>sample string 6</Reference> <RemainingInterval>1</RemainingInterval> <ScheduledActivationTimestamp>2024-05-03T06:40:21.8879096+00:00</ScheduledActivationTimestamp> <ScheduledMigrationDate>2024-05-03T06:40:21.8879096+00:00</ScheduledMigrationDate> <SubscriptionStatus>sample string 8</SubscriptionStatus> <SuspendedTimestamp>2024-05-03T06:40:21.8879096+00:00</SuspendedTimestamp> </SubscriptionSummary> <SubscriptionSummary> <Id>28</Id> <Uri>sample string 29</Uri> <AccountingStatus>sample string 23</AccountingStatus> <ActivatedTimestamp>2024-05-03T06:40:21.8879096+00:00</ActivatedTimestamp> <CanMigrate>true</CanMigrate> <CancellationTimestamp>2024-05-03T06:40:21.8879096+00:00</CancellationTimestamp> <CompanyName>sample string 17</CompanyName> <ContractEndTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractEndTimestamp> <ContractStartTimestamp>2024-05-03T06:40:21.8879096+00:00</ContractStartTimestamp> <CreatedTimestamp>2024-05-03T06:40:21.8879096+00:00</CreatedTimestamp> <Currency>sample string 18</Currency> <CustomerFirstName>sample string 14</CustomerFirstName> <CustomerId>1</CustomerId> <CustomerIsParent>true</CustomerIsParent> <CustomerLastName>sample string 15</CustomerLastName> <CustomerMiddleName>sample string 25</CustomerMiddleName> <CustomerParentId>1</CustomerParentId> <CustomerReference>sample string 16</CustomerReference> <CustomerStatus>sample string 24</CustomerStatus> <CustomerSuffix>sample string 26</CustomerSuffix> <CustomerTitle>sample string 27</CustomerTitle> <Description>sample string 5</Description> <ExpiryDate>2024-05-03T06:40:21.8879096+00:00</ExpiryDate> <GeotabDevicePlanId>1</GeotabDevicePlanId> <GeotabDevicePlanName>sample string 21</GeotabDevicePlanName> <Interval>sample string 7</Interval> <InvoiceOwner>sample string 19</InvoiceOwner> <InvoiceOwnerId>20</InvoiceOwnerId> <LastBillingDate>2024-05-03T06:40:21.8722768+00:00</LastBillingDate> <MigrationDate>2024-05-03T06:40:21.8879096+00:00</MigrationDate> <ModifiedTimestamp>2024-05-03T06:40:21.8879096+00:00</ModifiedTimestamp> <MonthlyRecurringRevenue>9</MonthlyRecurringRevenue> <Name>sample string 4</Name> <NetMonthlyRecurringRevenue>10</NetMonthlyRecurringRevenue> <NextBillingDate>2024-05-03T06:40:21.8879096+00:00</NextBillingDate> <NextPeriodStartDate>2024-05-03T06:40:21.8879096+00:00</NextPeriodStartDate> <NumberOfInterval>1</NumberOfInterval> <PlanCode>sample string 3</PlanCode> <PlanId>2</PlanId> <ProvisionedTimestamp>2024-05-03T06:40:21.8879096+00:00</ProvisionedTimestamp> <Reference>sample string 6</Reference> <RemainingInterval>1</RemainingInterval> <ScheduledActivationTimestamp>2024-05-03T06:40:21.8879096+00:00</ScheduledActivationTimestamp> <ScheduledMigrationDate>2024-05-03T06:40:21.8879096+00:00</ScheduledMigrationDate> <SubscriptionStatus>sample string 8</SubscriptionStatus> <SuspendedTimestamp>2024-05-03T06:40:21.8879096+00:00</SuspendedTimestamp> </SubscriptionSummary> </Results> </Subscriptions> <Term>sample string 7</Term> </BillingPeriodDefinition>