PUT Finance/ModifyInvoiceConfiguration

Modifies an existing InvoiceConfiguration.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ID		integer	None.
AllwaysRequired	This store requires an invoice for each order	boolean	None.
OrderAmountThreshold	OrderAmount Threshold that makes an invoice compulsory	decimal number	None.
AutoGenerationOrderTriggerID	The OrderStatus that triggers invoice auto generation and send	integer	None.
AutoGenerationOrderShippingTriggerID	The OrderShippingStatus that triggers invoice auto generation and send	integer	None.
UseOrderNumber	If true, Invoice.Number = Order.Number	boolean	None.
NextNumber	1 by default	string	None.
NumberIncreaseStep	1 by default	integer	Range: inclusive between 1 and 1000
NumberAutoResetPeriod	Each period change, number resets to 1. If null, auto reset is disabled	Period	None.
NumberFormat	Use {0} for the Number Use {1} for a date, if needed E.g. {0} E.g. Prefix-{0}-Suffix E.g. Prefix-{1:yyyy}/{0}-Suffix	string	None.
DueDays	Invoice due after (days)	decimal number	None.
DecrementNumberOnDelete	If true, on Invoice.Delete nextNumber = nextNumber - NumberIncreaseStep	boolean	None.
AutoSendInvoiceToCustomer	If true, all the invoices generated for this store will be automatically sent to the customer by email	boolean	None.
AdministratorEmail	Email account to receive automated invoice-related reports from the system	string	String length: inclusive between 0 and 100

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "AllwaysRequired": true,
  "OrderAmountThreshold": 3.0,
  "AutoGenerationOrderTriggerID": 1,
  "AutoGenerationOrderShippingTriggerID": 1,
  "UseOrderNumber": true,
  "NextNumber": "sample string 5",
  "NumberIncreaseStep": 6,
  "NumberAutoResetPeriod": 0,
  "NumberFormat": "sample string 7",
  "DueDays": 8.0,
  "DecrementNumberOnDelete": true,
  "AutoSendInvoiceToCustomer": true,
  "AdministratorEmail": "sample string 11"
}

application/xml, text/xml

Sample:

<InvoiceConfigurationBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Finance">
  <AdministratorEmail>sample string 11</AdministratorEmail>
  <AllwaysRequired>true</AllwaysRequired>
  <AutoGenerationOrderShippingTriggerID>1</AutoGenerationOrderShippingTriggerID>
  <AutoGenerationOrderTriggerID>1</AutoGenerationOrderTriggerID>
  <AutoSendInvoiceToCustomer>true</AutoSendInvoiceToCustomer>
  <DecrementNumberOnDelete>true</DecrementNumberOnDelete>
  <DueDays>8</DueDays>
  <ID>1</ID>
  <NextNumber>sample string 5</NextNumber>
  <NumberAutoResetPeriod>Hour</NumberAutoResetPeriod>
  <NumberFormat>sample string 7</NumberFormat>
  <NumberIncreaseStep>6</NumberIncreaseStep>
  <OrderAmountThreshold>3</OrderAmountThreshold>
  <UseOrderNumber>true</UseOrderNumber>
</InvoiceConfigurationBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>