PATCH v1/DraftInvoices

Documentation for 'Patch'.

Request Information

Parameters

NameDescriptionAdditional information
draftInvoice
Documentation for 'draftInvoice'.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
Click to beautify!
{
  "poNumber": "sample string 1",
  "notes": "sample string 2",
  "netTerms": "sample string 3",
  "netTermsSet": true,
  "draftCharges": [
    {
      "rangeQuantity": 1.0,
      "quantity": 1.0,
      "proratedUnitPrice": 1.0,
      "unitPrice": 1.0,
      "name": "sample string 1",
      "description": "sample string 2",
      "startServiceDate": "2024-05-03T11:54:48.6259407+00:00",
      "endServiceDate": "2024-05-03T11:54:48.641622+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
        },
        {
          "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
        },
        {
          "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": "2024-05-03T11:54:48.6259407+00:00",
      "endServiceDate": "2024-05-03T11:54:48.641622+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
        },
        {
          "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
        },
        {
          "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": "2024-05-03T11:54:48.6259407+00:00",
      "endServiceDate": "2024-05-03T11:54:48.641622+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
        },
        {
          "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
        },
        {
          "unitPrice": 1.0,
          "label": "sample string 2",
          "quantity": 3.0,
          "sortOrder": 4
        }
      ],
      "id": 4
    }
  ],
  "id": 5
}

application/xml, text/xml

Sample:
Click to beautify!
<DraftInvoice xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Patch">
  <Id>5</Id>
  <DraftCharges>
    <DraftCharge>
      <Id>4</Id>
      <Description>sample string 2</Description>
      <DraftChargeTiers>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
      </DraftChargeTiers>
      <DraftDiscounts>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
      </DraftDiscounts>
      <EndServiceDate>2024-05-03T11:54:48.641622+00:00</EndServiceDate>
      <Name>sample string 1</Name>
      <Operation>sample string 3</Operation>
      <ProratedUnitPrice>1</ProratedUnitPrice>
      <Quantity>1</Quantity>
      <RangeQuantity>1</RangeQuantity>
      <StartServiceDate>2024-05-03T11:54:48.6259407+00:00</StartServiceDate>
      <UnitPrice>1</UnitPrice>
    </DraftCharge>
    <DraftCharge>
      <Id>4</Id>
      <Description>sample string 2</Description>
      <DraftChargeTiers>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
      </DraftChargeTiers>
      <DraftDiscounts>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
      </DraftDiscounts>
      <EndServiceDate>2024-05-03T11:54:48.641622+00:00</EndServiceDate>
      <Name>sample string 1</Name>
      <Operation>sample string 3</Operation>
      <ProratedUnitPrice>1</ProratedUnitPrice>
      <Quantity>1</Quantity>
      <RangeQuantity>1</RangeQuantity>
      <StartServiceDate>2024-05-03T11:54:48.6259407+00:00</StartServiceDate>
      <UnitPrice>1</UnitPrice>
    </DraftCharge>
    <DraftCharge>
      <Id>4</Id>
      <Description>sample string 2</Description>
      <DraftChargeTiers>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
        <DraftChargeTier>
          <Label>sample string 2</Label>
          <Quantity>3</Quantity>
          <SortOrder>4</SortOrder>
          <UnitPrice>1</UnitPrice>
        </DraftChargeTier>
      </DraftChargeTiers>
      <DraftDiscounts>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
        <DraftDiscount>
          <Id>4</Id>
          <ConfiguredDiscountAmount>1</ConfiguredDiscountAmount>
          <Description>sample string 2</Description>
          <DiscountType>sample string 1</DiscountType>
          <Operation>sample string 3</Operation>
        </DraftDiscount>
      </DraftDiscounts>
      <EndServiceDate>2024-05-03T11:54:48.641622+00:00</EndServiceDate>
      <Name>sample string 1</Name>
      <Operation>sample string 3</Operation>
      <ProratedUnitPrice>1</ProratedUnitPrice>
      <Quantity>1</Quantity>
      <RangeQuantity>1</RangeQuantity>
      <StartServiceDate>2024-05-03T11:54:48.6259407+00:00</StartServiceDate>
      <UnitPrice>1</UnitPrice>
    </DraftCharge>
  </DraftCharges>
  <NetTerms>sample string 3</NetTerms>
  <NetTermsSet>true</NetTermsSet>
  <Notes>sample string 2</Notes>
  <PoNumber>sample string 1</PoNumber>
</DraftInvoice>

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!

Sample not available.