TAG LINE
SMALL TITLE

Invoice / Delivery

(API Version v1)


What can you do with InvoiceDelivery?


Properties

Property Details
id
"id": 13
Type: Number
This is the unique numeric identifier for the InvoiceDelivery
ownerId
"ownerId": 17
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
templateId
"templateId": 14
Type: Number
Unique identifier for the associated Template object.
emailTemplateId
"emailTemplateId": 0
Type: Number
Unique identifier for the associated EmailTemplate object.
invoiceDeliveryTypeId
"invoiceDeliveryTypeId": 27
Type: Number
Unique identifier for the associated InvoiceDeliveryType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • templateId
  • emailTemplateId
  • invoiceDeliveryTypeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the InvoiceDelivery object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v1/Invoice/Delivery/{id:int}
Delete an instance of the InvoiceDelivery object.
GETapi/v1/Invoice/Delivery
Retrieve all of the InvoiceDelivery objects.
GETapi/v1/Invoice/Delivery/Paged
Retreive all of the InvoiceDelivery objects in a paged fashion.
GETapi/v1/Invoice/Delivery/Paged/Detail
Retreive all of the InvoiceDelivery objects in a paged fashion with all object details.
GETapi/v1/Invoice/Delivery/{id:int}
Retrieve an instance of the InvoiceDelivery object by it's ID.
{id:int}Unique identifier for the InvoiceDelivery object.
GETapi/v1/Invoice/Delivery/{id:int}/Detail
Retreive all of the Detail objects for the specified InvoiceDelivery.
{id:int}Unique identifier for the InvoiceDelivery object.
PATCHapi/v1/Invoice/Delivery/{id:int}
Update the InvoiceDelivery object and optionally make changes to any child objects.
POSTapi/v1/Invoice/Delivery
Create a new instance of the InvoiceDelivery object.
PUTapi/v1/Invoice/Delivery/{id:int}
Update an existing instance of the InvoiceDelivery object.