Invoice / Configuration

What can you do with InvoiceConfiguration?


Properties

Property Details
id
"id": 553
Type: Number
This is the unique numeric identifier for the InvoiceConfiguration
ownerId
"ownerId": 970
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
invoiceTemplateId
"invoiceTemplateId": 675
Type: Number
Unique identifier for the associated InvoiceTemplate object.
defaultInvoiceDeliveryTypeId
"defaultInvoiceDeliveryTypeId": 496
Type: Number
Unique identifier for the associated InvoiceDeliveryType object.
export
"export": true
Type: Boolean
exportPath
"exportPath": "Hello World"
Type: String
invoiceCreditTemplateId
"invoiceCreditTemplateId": 987
Type: Number
Unique identifier for the associated InvoiceCreditTemplate object.
emailSubject
"emailSubject": "Hello World"
Type: String
emailInvoiceBodyOptionTypeId
"emailInvoiceBodyOptionTypeId": 928
Type: Number
Unique identifier for the associated EmailInvoiceBodyOptionType object.
emailInvoiceAttachmentOptionTypeId
"emailInvoiceAttachmentOptionTypeId": 458
Type: Number
Unique identifier for the associated EmailInvoiceAttachmentOptionType object.
emailBody
"emailBody": "Hello World"
Type: String
noChargeInvoiceDeliveryTypeId
"noChargeInvoiceDeliveryTypeId": 530
Type: Number
Unique identifier for the associated NoChargeInvoiceDeliveryType object.
invoiceExportOptionTypeId
"invoiceExportOptionTypeId": 292
Type: Number
Unique identifier for the associated InvoiceExportOptionType object.
ownerEmailSettingsId
"ownerEmailSettingsId": 318
Type: Number
Unique identifier for the associated OwnerEmailSettings object.
snapshotInvoiceTemplateId
"snapshotInvoiceTemplateId": 484
Type: Number
Unique identifier for the associated InvoiceTemplate 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
  • invoiceTemplateId
  • defaultInvoiceDeliveryTypeId
  • export
  • exportPath
  • invoiceCreditTemplateId
  • emailSubject
  • emailInvoiceBodyOptionTypeId
  • emailInvoiceAttachmentOptionTypeId
  • emailBody
  • noChargeInvoiceDeliveryTypeId
  • invoiceExportOptionTypeId
  • ownerEmailSettingsId
  • snapshotInvoiceTemplateId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Invoice/Configuration/{id:int}
Delete an instance of the InvoiceConfiguration object.
GETapi/v1/Invoice/Configuration
Retrieve all of the InvoiceConfiguration objects.
GETapi/v1/Invoice/Configuration/Metadata
Retrieve all of the meta data details of the InvoiceConfiguration object.
GETapi/v1/Invoice/Configuration/Metadata/{option}
Retrieve all the meta data details of the InvoiceConfiguration object based on provided options.
{option}Metadata options for the InvoiceConfiguration object.
GETapi/v1/Invoice/Configuration/Paged
Retreive all of the InvoiceConfiguration objects in a paged fashion.
GETapi/v1/Invoice/Configuration/{id:int}
Retrieve an instance of the InvoiceConfiguration object by it's ID.
{id:int}Unique identifier for the InvoiceConfiguration object.
POSTapi/v1/Invoice/Configuration
Create a new instance of the InvoiceConfiguration object.
PUTapi/v1/Invoice/Configuration/{id:int}
Update an existing instance of the InvoiceConfiguration object.