DocCloud API

<back to all web services

UpdateInvoiceOrderCommand

Requires Authentication
The following routes are available for this service:
PUT/invoice/order/{id}
UpdateInvoiceOrderCommand Parameters:
NameParameterData TypeRequiredDescription
IdpathulongNo
PositionsbodyList<InvoiceOrderPositionDto>No
DescriptionbodystringNo
CurrencyIdbodyuintNo
CurrencybodystringNo
RecbodyShortRecipientDtoNo
InvoiceOrderPositionDto Parameters:
NameParameterData TypeRequiredDescription
ProductIdformuintNo
InvoicerOrderIdformulongNo
NameformstringNo
CodeformstringNo
QuantityformdecimalNo
UnitIdformuintNo
UnitformstringNo
CurrencyIdformuintNo
CurrencyformstringNo
UnitPriceformdecimalNo
GrossformdecimalNo
NettoformdecimalNo
VatTypeIdformintNo
Vat5formdecimalNo
Vat8formdecimalNo
Vat23formdecimalNo
IsUpdatedformboolNo
IsDeletedformboolNo
BaseKeyLongDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformulongNo
ShortRecipientDto Parameters:
NameParameterData TypeRequiredDescription
IdformuintNo
CatIdformuintNo
NameformstringNo
VatIdformstringNo
StreetNameformstringNo
StreetNumberformstringNo
FlatNumberformstringNo
PostalCodeformstringNo
TownformstringNo
CountryIdformintNo
IsoCountryformstringNo
CountryformstringNo
EmailformstringNo
PhoneformstringNo
BankNameformstringNo
BankAccountNbformstringNo
IsActualformboolNo
DefaultCurrencyIdformuintNo
DefaultCurrencyformstringNo
CategoryIdformuintNo
CategoryNameformstringNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /invoice/order/{id} HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateInvoiceOrderCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceOrder.Command">
  <Currency>String</Currency>
  <CurrencyId>0</CurrencyId>
  <Description>String</Description>
  <Id>0</Id>
  <Positions xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceOrder.Model">
    <d2p1:InvoiceOrderPositionDto>
      <CreatedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</CreatedById>
      <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</CreatedDate>
      <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</Id>
      <ModifiedById xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0</ModifiedById>
      <ModifiedDate xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Base">0001-01-01T00:00:00</ModifiedDate>
      <d2p1:Code>String</d2p1:Code>
      <d2p1:Currency>String</d2p1:Currency>
      <d2p1:CurrencyId>0</d2p1:CurrencyId>
      <d2p1:Gross>0</d2p1:Gross>
      <d2p1:InvoicerOrderId>0</d2p1:InvoicerOrderId>
      <d2p1:IsDeleted>false</d2p1:IsDeleted>
      <d2p1:IsUpdated>false</d2p1:IsUpdated>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Netto>0</d2p1:Netto>
      <d2p1:ProductId>0</d2p1:ProductId>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:Unit>String</d2p1:Unit>
      <d2p1:UnitId>0</d2p1:UnitId>
      <d2p1:UnitPrice>0</d2p1:UnitPrice>
      <d2p1:Vat23>0</d2p1:Vat23>
      <d2p1:Vat5>0</d2p1:Vat5>
      <d2p1:Vat8>0</d2p1:Vat8>
      <d2p1:VatTypeId>0</d2p1:VatTypeId>
    </d2p1:InvoiceOrderPositionDto>
  </Positions>
  <Rec xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Model">
    <d2p1:BankAccountNb>String</d2p1:BankAccountNb>
    <d2p1:BankName>String</d2p1:BankName>
    <d2p1:CatId>0</d2p1:CatId>
    <d2p1:CategoryId>0</d2p1:CategoryId>
    <d2p1:CategoryName>String</d2p1:CategoryName>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:CountryId>0</d2p1:CountryId>
    <d2p1:DefaultCurrency>String</d2p1:DefaultCurrency>
    <d2p1:DefaultCurrencyId>0</d2p1:DefaultCurrencyId>
    <d2p1:Email>String</d2p1:Email>
    <d2p1:FlatNumber>String</d2p1:FlatNumber>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:IsActual>false</d2p1:IsActual>
    <d2p1:IsoCountry>String</d2p1:IsoCountry>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:Phone>String</d2p1:Phone>
    <d2p1:PostalCode>String</d2p1:PostalCode>
    <d2p1:StreetName>String</d2p1:StreetName>
    <d2p1:StreetNumber>String</d2p1:StreetNumber>
    <d2p1:Town>String</d2p1:Town>
    <d2p1:VatId>String</d2p1:VatId>
  </Rec>
</UpdateInvoiceOrderCommand>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateInvoiceOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceOrder.Command">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Result xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global" />
  <Id xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.Recipient.Global">0</Id>
</UpdateInvoiceOrderResponse>