Update or Add the InvoiceDelivery object and optionally make changes to any child objects.

patch

https://{server_address}/ResourceServer/api/v10/Invoice/Delivery/{id}

Path Params

integer

required

Unique identifier for the InvoiceDelivery object.

Body Params

This entity represents the configuration of Invoice delivery details (i.e. via email or offline), and associated templates to be used (i.e. invoice and email delivery templates).

name

string

templateId

number

The invoice template to use with this delivery method. Unique identifier for the associated Template object.

templateName

string

The name of the object associated with the templateId property.

emailTemplateId

number

The email template to use with this delivery method. Unique identifier for the associated EmailTemplate object.

emailTemplateName

string

The name of the object associated with the emailTemplateId property.

invoiceDeliveryTypeId

number

Specifying if this is email delivery or offline. Unique identifier for the associated InvoiceDeliveryType object.

invoiceDeliveryTypeName

string

The name of the object associated with the invoiceDeliveryTypeId property.

transferLocationId

number

Unique identifier for the associated TransferLocation object.

transferLocationName

string

The name of the object associated with the transferLocationId property.

doNotEmailZeroChargeInvoice

boolean

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.

400The request could not be processed.