Edit

Share via

InsertionOrderPendingChanges Data Object - Customer Billing

  • Article

Defines an object that can be used to manage changes for an approved insertion order.

If the Status element of the InsertionOrder is set to PendingUserReview then you cannot update the insertion order via the InsertionOrderPendingChanges object. You must initially approve, decline, or cancel via the Status element of the InsertionOrder. Once the insertion order Status is Active, Exhausted, Expired, or NotStarted, then you can either make new changes or approve or decline the current pending changes via the InsertionOrderPendingChanges object.

Syntax

<xs:complexType name="InsertionOrderPendingChanges" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Comment" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="EndDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="RequestedByUserId" nillable="true" type="xs:int" />
    <xs:element minOccurs="0" name="ModifiedDateTime" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="NotificationThreshold" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="ReferenceId" nillable="true" type="xs:long" />
    <xs:element minOccurs="0" name="SpendCapAmount" nillable="true" type="xs:double" />
    <xs:element minOccurs="0" name="StartDate" nillable="true" type="xs:dateTime" />
    <xs:element minOccurs="0" name="Name" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="PurchaseOrder" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="ChangeStatus" nillable="true" type="tns:InsertionOrderPendingChangesStatus" />
  </xs:sequence>
</xs:complexType>

Elements

The InsertionOrderPendingChanges object has the following elements: ChangeStatus, Comment, EndDate, ModifiedDateTime, Name, NotificationThreshold, PurchaseOrder, ReferenceId, RequestedByUserId, SpendCapAmount, StartDate.

Element Description Data Type
ChangeStatus Can be used to accept or decline the insertion order pending changes.

When you call UpdateInsertionOrder you can either set this ChangeStatus element or modify other elements of this object, but you cannot change the status in parallel with other property updates.		 InsertionOrderPendingChangesStatus
Comment A description of the insertion order. The description is limited to 100 characters.

Add: Read-only
Update: Optional		 string
EndDate The date that the insertion order expires. The end date must be later than the start date.

The date is stored in Coordinated Universal Time (UTC). Only the month, day, and year of the specified string are used. If you specify the hour, minutes, and seconds of a date they will be ignored.

For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

This element is empty if the insertion order has no end date.

Add: Read-only
Update: Optional		 dateTime
ModifiedDateTime The date and time that the insertion order change request was submitted.

The date is stored in Coordinated Universal Time (UTC).

For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Read-only		 dateTime
Name The friendly name that can be used to reference this insertion order.

The name can contain a maximum of 100 characters.

The name does not need to be unique compared to other insertion orders for the customer.

Add: Read-only
Update: Optional		 string
NotificationThreshold A percentage of the budget that has been spent. Specify the percentage as a value from 0 to 100. Notification is sent when the threshold is reached. For example, if you set the threshold to 70, the Billing service sends notification when you have spent 70 percent of the budget.

If you do not want to receive notification, set to NULL.

Reserved for internal use.

Add: Read-only
Update: Optional		 double
PurchaseOrder A purchase order value that can be used to reference this insertion order in monthly invoices. This value will be printed as the purchase order in the monthly invoices.

The purchase order can contain a maximum of 50 characters.

Add: Read-only
Update: Optional		 string
ReferenceId Internal use only.

Add: Read-only
Update: Optional		 long
RequestedByUserId An identifier of the last user to request a change to the insertion order.

Add: Read-only
Update: Read-only		 int
SpendCapAmount The budget for this insertion order. The budget is a hard limit. When the account reaches this limit and there is not another insertion order available, the account's lifecycle status value is set to Pause.

This element is empty if the insertion order has unlimited budget.

Add: Read-only
Update: Optional		 double
StartDate The date that the insertion order can begin accruing charges. The start date must be later than the current date.

The date is stored in Coordinated Universal Time (UTC). Only the month, day, and year of the specified string are used. If you specify the hour, minutes, and seconds of a date they will be ignored.

For information about the format of the date and time, see the dateTime entry in Primitive XML Data Types.

Add: Read-only
Update: Optional. You can only update the start date via this element if the Status element of the InsertionOrder is NotStarted. If the start date has already passed, then you cannot change it.		 dateTime

Requirements

Service: CustomerBillingService.svc v13
Namespace: https://bingads.microsoft.com/Customer/v13/Entities

Used By

InsertionOrder