PUT v1/customers/{id}/billingsettings

Request Information

URI Parameters

Name	Description	Type	Additional information
id		string	None.

Body Parameters

Common.Dto.Put.CustomerBillingSetting

Name	Type	Additional information
invoiceDay	integer	None.
invoiceWeekday	string	None.
term	string	None.
interval	string	None.
autoCollect	boolean	None.
dunningExempt	boolean	None.
rechargeType	string	None.
rechargeThresholdAmount	decimal number	Matching regular expression pattern: ^\d*.?\d{0,2}?$ Range: inclusive between 0.00 and 79228162514264337593543950335
rechargeTargetAmount	decimal number	Matching regular expression pattern: ^\d*.?\d{0,2}?$ Range: inclusive between 0.00 and 79228162514264337593543950335
statusOnThreshold	boolean	None.
autoPostDraftInvoice	boolean	None.
customerGracePeriod	integer	None.
gracePeriodExtension	integer	None.
customerAutoCancel	integer	None.
defaultCancelOption	string	None.
standingPoNumber	string	None.
billingPeriodConfigurations	Collection of Common.Dto.Put.BillingPeriodConfiguration	None.
acquisitionCost	decimal number	Range: inclusive between 0.00 and 79228162514264337593543950335
showZeroDollarCharges	boolean	None.
taxExempt	boolean	None.
taxExemptCode	string	String length: inclusive between 0 and 255
useCustomerBillingAddress	boolean	None.
avalaraUsageType	string	String length: inclusive between 0 and 4
vatIdentificationNumber	string	String length: inclusive between 0 and 25
customerServiceStartOption	string	None.
rollUpTaxes	boolean	None.
rollUpDiscounts	boolean	None.
invoiceSummarization	boolean	None.
invoiceSummarizationOption	string	None.
rollUpPdfsDisplayName	boolean	None.
rollUpPdfsDisplayDescription	boolean	None.
rollUpPdfsDisplayAllUnitPrices	boolean	None.
pdfInvoiceEmailAttachmentOption	string	None.
invoiceSummarizationFollowAccountDefaults	boolean	None.
trackedItemDisplay	Common.Dto.Put.TrackedItemDisplay	None.
customerBillingStatementSetting	Common.Dto.Put.CustomerBillingStatementSetting	None.
postReadyChargesOnRenew	boolean	None.
autoCollectSettingType	string	None.
HierarchySuspendOption	string	None.
draftInvoiceIncludeWatermark	boolean	None.
projectedInvoiceIncludeWatermark	boolean	None.
invoiceIncludeWatermark	boolean	None.
id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "invoiceDay": 1,
  "invoiceWeekday": "sample string 1",
  "term": "sample string 2",
  "interval": "sample string 3",
  "autoCollect": true,
  "dunningExempt": true,
  "rechargeType": "sample string 5",
  "rechargeThresholdAmount": 1.0,
  "rechargeTargetAmount": 1.0,
  "statusOnThreshold": true,
  "autoPostDraftInvoice": true,
  "customerGracePeriod": 1,
  "gracePeriodExtension": 1,
  "customerAutoCancel": 1,
  "defaultCancelOption": "sample string 6",
  "standingPoNumber": "sample string 7",
  "billingPeriodConfigurations": [
    {
      "type": "sample string 1",
      "rule": "sample string 2",
      "interval": "sample string 3",
      "day": 1,
      "weekday": "sample string 4",
      "month": 1
    },
    {
      "type": "sample string 1",
      "rule": "sample string 2",
      "interval": "sample string 3",
      "day": 1,
      "weekday": "sample string 4",
      "month": 1
    }
  ],
  "acquisitionCost": 1.0,
  "showZeroDollarCharges": true,
  "taxExempt": true,
  "taxExemptCode": "sample string 9",
  "useCustomerBillingAddress": true,
  "avalaraUsageType": "sample string 10",
  "vatIdentificationNumber": "sample string 11",
  "customerServiceStartOption": "sample string 12",
  "rollUpTaxes": true,
  "rollUpDiscounts": true,
  "invoiceSummarization": true,
  "invoiceSummarizationOption": "sample string 14",
  "rollUpPdfsDisplayName": true,
  "rollUpPdfsDisplayDescription": true,
  "rollUpPdfsDisplayAllUnitPrices": true,
  "pdfInvoiceEmailAttachmentOption": "sample string 18",
  "invoiceSummarizationFollowAccountDefaults": true,
  "trackedItemDisplay": {
    "trackedItemDisplayFormat": "sample string 1",
    "showTrackedItemName": {},
    "showTrackedItemReference": {},
    "showTrackedItemDescription": {},
    "showTrackedItemCreatedDate": {}
  },
  "customerBillingStatementSetting": {
    "option": "sample string 1",
    "type": "sample string 2",
    "interval": "sample string 3",
    "day": 1,
    "month": 1,
    "trackedItemDisplay": {
      "trackedItemDisplayFormat": "sample string 1",
      "showTrackedItemName": {},
      "showTrackedItemReference": {},
      "showTrackedItemDescription": {},
      "showTrackedItemCreatedDate": {}
    },
    "statementActivityType": "sample string 4"
  },
  "postReadyChargesOnRenew": true,
  "autoCollectSettingType": "sample string 20",
  "HierarchySuspendOption": "sample string 21",
  "draftInvoiceIncludeWatermark": true,
  "projectedInvoiceIncludeWatermark": true,
  "invoiceIncludeWatermark": true,
  "id": 22
}

Response Information

Resource Description

Common.Dto.Get.CustomerBillingSetting

Name	Type	Additional information
invoiceDay	integer	None.
term	string	None.
interval	string	None.
autoCollect	boolean	None.
dunningExempt	boolean	None.
rechargeType	string	None.
rechargeThresholdAmount	decimal number	None.
rechargeTargetAmount	decimal number	None.
statusOnThreshold	boolean	None.
autoPostDraftInvoice	boolean	None.
hasPaymentMethod	boolean	None.
customerGracePeriod	integer	None.
gracePeriodExtension	integer	None.
customerAutoCancel	integer	None.
defaultCancelOption	string	None.
standingPoNumber	string	None.
billingPeriodConfigurations	Collection of Common.Dto.Get.BillingPeriodConfiguration	None.
acquisitionCost	decimal number	None.
showZeroDollarCharges	boolean	None.
taxExempt	boolean	None.
useCustomerBillingAddress	boolean	None.
taxExemptCode	string	None.
avalaraUsageType	string	None.
vatIdentificationNumber	string	None.
customerServiceStartOption	string	None.
rollUpTaxes	boolean	None.
rollUpDiscounts	boolean	None.
rollUpPdfsByPlanProduct	boolean	None.
invoiceSummarization	boolean	None.
invoiceSummarizationOption	string	None.
rollUpPdfsDisplayName	boolean	None.
rollUpPdfsDisplayDescription	boolean	None.
rollUpPdfsDisplayAllUnitPrices	boolean	None.
pdfInvoiceEmailAttachmentOption	string	None.
invoiceSummarizationFollowAccountDefaults	boolean	None.
trackedItemDisplay	Common.Dto.Get.TrackedItemDisplay	None.
customerBillingStatementSetting	Common.Dto.Get.CustomerBillingStatementSetting	None.
defaultPaymentMethodId	integer	None.
postReadyChargesOnRenew	boolean	None.
autoCollectSettingType	string	None.
hierarchySuspendOption	string	None.
draftInvoiceIncludeWatermark	boolean	None.
projectedInvoiceIncludeWatermark	boolean	None.
invoiceIncludeWatermark	boolean	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "invoiceDay": 1,
  "term": "sample string 1",
  "interval": "sample string 2",
  "autoCollect": true,
  "dunningExempt": true,
  "rechargeType": "sample string 4",
  "rechargeThresholdAmount": 1.0,
  "rechargeTargetAmount": 1.0,
  "statusOnThreshold": true,
  "autoPostDraftInvoice": true,
  "hasPaymentMethod": true,
  "customerGracePeriod": 1,
  "gracePeriodExtension": 1,
  "customerAutoCancel": 1,
  "defaultCancelOption": "sample string 6",
  "standingPoNumber": "sample string 7",
  "billingPeriodConfigurations": [
    {
      "type": "sample string 1",
      "rule": "sample string 2",
      "interval": "sample string 3",
      "day": 1,
      "weekday": "sample string 4",
      "month": 1
    },
    {
      "type": "sample string 1",
      "rule": "sample string 2",
      "interval": "sample string 3",
      "day": 1,
      "weekday": "sample string 4",
      "month": 1
    }
  ],
  "acquisitionCost": 8.0,
  "showZeroDollarCharges": true,
  "taxExempt": true,
  "useCustomerBillingAddress": true,
  "taxExemptCode": "sample string 10",
  "avalaraUsageType": "sample string 11",
  "vatIdentificationNumber": "sample string 12",
  "customerServiceStartOption": "sample string 13",
  "rollUpTaxes": true,
  "rollUpDiscounts": true,
  "rollUpPdfsByPlanProduct": true,
  "invoiceSummarization": true,
  "invoiceSummarizationOption": "sample string 16",
  "rollUpPdfsDisplayName": true,
  "rollUpPdfsDisplayDescription": true,
  "rollUpPdfsDisplayAllUnitPrices": true,
  "pdfInvoiceEmailAttachmentOption": "sample string 20",
  "invoiceSummarizationFollowAccountDefaults": true,
  "trackedItemDisplay": {
    "trackedItemDisplayFormat": "sample string 1",
    "showTrackedItemName": true,
    "showTrackedItemReference": true,
    "showTrackedItemDescription": true,
    "showTrackedItemCreatedDate": true
  },
  "customerBillingStatementSetting": {
    "option": "sample string 1",
    "type": "sample string 2",
    "interval": "sample string 3",
    "day": 1,
    "month": 1,
    "trackedItemDisplay": {
      "trackedItemDisplayFormat": "sample string 1",
      "showTrackedItemName": true,
      "showTrackedItemReference": true,
      "showTrackedItemDescription": true,
      "showTrackedItemCreatedDate": true
    },
    "statementActivityType": "sample string 4"
  },
  "defaultPaymentMethodId": 1,
  "postReadyChargesOnRenew": true,
  "autoCollectSettingType": "sample string 22",
  "hierarchySuspendOption": "sample string 23",
  "draftInvoiceIncludeWatermark": true,
  "projectedInvoiceIncludeWatermark": true,
  "invoiceIncludeWatermark": true,
  "id": 24,
  "uri": "sample string 25"
}