Update Bill To Contact Action

Update the Bill to Contact detail on an invoice to ensure accurate billing communication and routing.

Specify the invoice ID and the new Bill to Contact detail. Optionally, indicate whether the new contact must be set as the default for future invoices. Use this action to change the contact to be billed on an invoice, for example, when handling a billing dispute.

This action is available in API version 66.0 and later.

Special Access Rules

The Update Bill To Contact Action is available in Enterprise, Developer, and Unlimited Editions where Dispute Management is enabled in Billing.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/blngSvcUpdateBillToContact

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`invoiceId`	string	ID of the invoice whose Bill to Contact detail must be updated.
`newBillToContactId`	string	ID of the Bill to Contact record to be updated on the invoice.
`setAsDefault`	boolean	Indicates whether the new Bill to Contact detail must be set as default for future invoices (`true`) or not (`false`). The default value is `false`.

Outputs

Output	Type	Description
`additionalInformation`	string	Any additional information to be included in the response.
`isSuccess`	boolean	Indicates whether the Bill to Contact detail is updated on the invoice record (`true`) or not (`false`).

Example

POST

This sample request is for the Update Bill To Contact action.

1{
2  "inputs": [
3    {
4      "invoiceID": "3ttxx0000000001AAA",
5      "newBillToContactid": "003xx000004XYZPAA4",
6      "setAsDefault": true
7    }
8  ]
9}

This sample response is for the Update Bill To Contact action.

1[
2  {
3    "actionName": "blngSvcUpdateBillToContact",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isSuccess": true,
10      "additionalInformation": "{\"status\":\"Success\",\"notes\":\"Default billing contact updated.\"}"
11    },
12    "sortOrder": -1,
13    "version": 1
14  }
15]