Documentation for POST api/Personal/Order/UpdateDengenetInvoices

POST api/Personal/Order/UpdateDengenetInvoices

Update one or more orders with Invoice information from Dengenet

Request Information

URI Parameters

None.

Body Parameters

A list of Order Invoices

Name	Description	Type	Additional information
OrderID	The ByDesign Order # Associated to the invoice	integer	None.
EInvoiceNumber	EInvoice Number	string	None.
EInvoiceURL	URL for viewing the EInvoice	string	None.
EInvoiceStatus	The status of the invoice. A value of "Approved" will mark the EInvoice as approved	string	None.
AdditionalMessaging	Optional messaging to return with this record. Could be used for errors or approval failure messaging.	string	None.

Request Formats

application/xml, text/xml

Sample:

<ListOfDengenetInvoiceViewModel>
  <DengenetInvoiceViewModel>
    <OrderID>1</OrderID>
    <EInvoiceNumber>sample string 2</EInvoiceNumber>
    <EInvoiceURL>sample string 3</EInvoiceURL>
    <EInvoiceStatus>sample string 4</EInvoiceStatus>
    <AdditionalMessaging>sample string 5</AdditionalMessaging>
  </DengenetInvoiceViewModel>
  <DengenetInvoiceViewModel>
    <OrderID>1</OrderID>
    <EInvoiceNumber>sample string 2</EInvoiceNumber>
    <EInvoiceURL>sample string 3</EInvoiceURL>
    <EInvoiceStatus>sample string 4</EInvoiceStatus>
    <AdditionalMessaging>sample string 5</AdditionalMessaging>
  </DengenetInvoiceViewModel>
</ListOfDengenetInvoiceViewModel>

application/json, text/json

Sample:

[
  {
    "OrderID": 1,
    "EInvoiceNumber": "sample string 2",
    "EInvoiceURL": "sample string 3",
    "EInvoiceStatus": "sample string 4",
    "AdditionalMessaging": "sample string 5"
  },
  {
    "OrderID": 1,
    "EInvoiceNumber": "sample string 2",
    "EInvoiceURL": "sample string 3",
    "EInvoiceStatus": "sample string 4",
    "AdditionalMessaging": "sample string 5"
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'IEnumerable`1'.

Response Information

Resource Description

IOperationResult

Name	Type	Additional information
IsSuccessful	boolean	None.
ValidationErrors	Dictionary of string [key] and string [value]	None.
Value	Object	None.

Response Formats

application/xml, text/xml

Sample:

<OperationResult>
  <IsSuccessful>False</IsSuccessful>
  <ValidationErrors />
  <Value />
</OperationResult>

application/json, text/json

Sample:

{
  "IsSuccessful": false,
  "ValidationErrors": {}
}