PATCH v1/DraftInvoices

Request Information

URI Parameters

None.

Body Parameters

Common.Dto.Patch.DraftInvoice

Name	Type	Additional information
poNumber	string	String length: inclusive between 0 and 255
notes	string	String length: inclusive between 0 and 2000
netTerms	string	None.
netTermsSet	boolean	None.
referenceDate	date	None.
referenceDateSet	boolean	None.
draftCharges	Collection of Common.Dto.Patch.DraftCharge	None.
id	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "poNumber": "sample string 1",
  "notes": "sample string 2",
  "netTerms": "sample string 3",
  "netTermsSet": true,
  "referenceDate": "2025-05-21T07:41:36.9634928+00:00",
  "referenceDateSet": true,
  "draftCharges": [
    {
      "rangeQuantity": 1.0,
      "quantity": 1.0,
      "proratedUnitPrice": 1.0,
      "unitPrice": 1.0,
      "name": "sample string 1",
      "description": "sample string 2",
      "startServiceDate": "2025-05-21T07:41:36.9634928+00:00",
      "endServiceDate": "2025-05-21T07:41:36.9634928+00:00",
      "operation": "sample string 3",
      "draftDiscounts": [
        {
          "configuredDiscountAmount": 1.0,
          "discountType": "sample string 1",
          "description": "sample string 2",
          "operation": "sample string 3",
          "id": 4
        },
        {
          "configuredDiscountAmount": 1.0,
          "discountType": "sample string 1",
          "description": "sample string 2",
          "operation": "sample string 3",
          "id": 4
        }
      ],
      "draftChargeTiers": [
        {
          "unitPrice": 1.0,
          "label": "sample string 2",
          "quantity": 3.0,
          "sortOrder": 4
        },
        {
          "unitPrice": 1.0,
          "label": "sample string 2",
          "quantity": 3.0,
          "sortOrder": 4
        }
      ],
      "id": 4
    },
    {
      "rangeQuantity": 1.0,
      "quantity": 1.0,
      "proratedUnitPrice": 1.0,
      "unitPrice": 1.0,
      "name": "sample string 1",
      "description": "sample string 2",
      "startServiceDate": "2025-05-21T07:41:36.9634928+00:00",
      "endServiceDate": "2025-05-21T07:41:36.9634928+00:00",
      "operation": "sample string 3",
      "draftDiscounts": [
        {
          "configuredDiscountAmount": 1.0,
          "discountType": "sample string 1",
          "description": "sample string 2",
          "operation": "sample string 3",
          "id": 4
        },
        {
          "configuredDiscountAmount": 1.0,
          "discountType": "sample string 1",
          "description": "sample string 2",
          "operation": "sample string 3",
          "id": 4
        }
      ],
      "draftChargeTiers": [
        {
          "unitPrice": 1.0,
          "label": "sample string 2",
          "quantity": 3.0,
          "sortOrder": 4
        },
        {
          "unitPrice": 1.0,
          "label": "sample string 2",
          "quantity": 3.0,
          "sortOrder": 4
        }
      ],
      "id": 4
    }
  ],
  "id": 6
}

Response Information

Resource Description

Common.Dto.Get.DraftInvoice

Name	Type	Additional information
billingPeriodId	integer	None.
billingPeriodDefinitionId	integer	None.
effectiveTimestamp	date	None.
estimatedDueDateTimestamp	date	None.
modifiedTimestamp	date	None.
status	string	None.
poNumber	string	None.
draftCharges	Collection of Common.Dto.Get.DraftCharge	None.
draftChargeGroups	Collection of Common.Dto.Get.DraftChargeGroup	None.
subtotal	decimal number	None.
totalDiscount	decimal number	None.
total	decimal number	None.
tax	Common.Dto.Get.Tax	None.
taxes	Collection of Common.Dto.Get.Tax	None.
paymentSchedules	Collection of Common.Dto.Get.DraftPaymentSchedule	None.
customer	Common.Dto.Get.DraftInvoiceCustomer	None.
notes	string	None.
shippingInstructions	string	None.
customerReferenceValue	string	None.
terms	string	None.
defaultTerms	string	None.
isDefaultTerms	boolean	None.
lastGenerated	string	None.
rollUpPdf	boolean	None.
invoiceSummarizationOption	string	None.
childCharges	Collection of Common.Dto.Get.DraftChildChargeSummary	None.
childChargeTotals	Common.Dto.Get.ChildChargeSummary	None.
parentSummary	Common.Dto.Get.ParentChargeSummary	None.
totalChargeCount	integer	None.
totalPostableChargeCount	integer	None.
hasPurchasePerformanceObligations	boolean	None.
avalaraId	string	None.
isTermsEditableFromPaymentScheduleDates	boolean	None.
referenceDate	date	None.
id	integer	None.
uri	string	None.

Response Formats

application/json, text/json

Sample:

Sample not available.