DocCloud API

<back to all web services

UpdateInvoicesCommand

Requires Authentication
The following routes are available for this service:
PUT/serial/update/invoiceupdate invoices
UpdateInvoicesCommand Parameters:
NameParameterData TypeRequiredDescription
InvoiceIdsbodyList<ulong>No
IsIncomebodyboolNo
CategoryIdbodyuint?No
CategoryNamebodystringNo
PaymentDueDatebodyDateTime?No
PaymentTypeIdbodyuint?No
PaymentTypebodystringNo
PaymentTermsbodyushort?No
JpkItemCodeIdbodyint?No
JpkItemCodeCodebodystringNo
JpkItemCodeNamebodystringNo
ListJpkProcedurebodystringNo
JpkDocTypeIdbodyint?No
JpkDocTypeCodebodystringNo
JpkDocTypeNamebodystringNo
RecIdbodyuint?No
RecNamebodystringNo
RecVatIdbodystringNo
RecStreetNamebodystringNo
RecStreetNumberbodystringNo
RecFlatNumberbodystringNo
RecPostalCodebodystringNo
RecTownbodystringNo
RecCountryIdbodyuint?No
RecIsoCountrybodystringNo
RecCountrybodystringNo
SellIdbodyuint?No
SellNamebodystringNo
SellVatIdbodystringNo
SellStreetNamebodystringNo
SellStreetNumberbodystringNo
SellFlatNumberbodystringNo
SellPostalCodebodystringNo
SellTownbodystringNo
SellCountryIdbodyuint?No
SellIsoCountrybodystringNo
SellCountrybodystringNo
DescriptionbodystringNo
RegistryVatPositionsPatchbodyRegistryVatPositionPatchNo
DeleteSettlementRegulationsbodyboolNo
RegistryVatPositionPatch Parameters:
NameParameterData TypeRequiredDescription
CategoryIdformuint?No
CategoryNameformstringNo
KindIdformint?No
KindNameformstringNo
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 /serial/update/invoice HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateInvoicesCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.SerialOperations.Command">
  <CategoryId>0</CategoryId>
  <CategoryName>String</CategoryName>
  <DeleteSettlementRegulations>false</DeleteSettlementRegulations>
  <Description>String</Description>
  <InvoiceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:unsignedLong>0</d2p1:unsignedLong>
  </InvoiceIds>
  <IsIncome>false</IsIncome>
  <JpkDocTypeCode>String</JpkDocTypeCode>
  <JpkDocTypeId>0</JpkDocTypeId>
  <JpkDocTypeName>String</JpkDocTypeName>
  <JpkItemCodeCode>String</JpkItemCodeCode>
  <JpkItemCodeId>0</JpkItemCodeId>
  <JpkItemCodeName>String</JpkItemCodeName>
  <ListJpkProcedure>String</ListJpkProcedure>
  <PaymentDueDate>0001-01-01T00:00:00</PaymentDueDate>
  <PaymentTerms>0</PaymentTerms>
  <PaymentType>String</PaymentType>
  <PaymentTypeId>0</PaymentTypeId>
  <RecCountry>String</RecCountry>
  <RecCountryId>0</RecCountryId>
  <RecFlatNumber>String</RecFlatNumber>
  <RecId>0</RecId>
  <RecIsoCountry>String</RecIsoCountry>
  <RecName>String</RecName>
  <RecPostalCode>String</RecPostalCode>
  <RecStreetName>String</RecStreetName>
  <RecStreetNumber>String</RecStreetNumber>
  <RecTown>String</RecTown>
  <RecVatId>String</RecVatId>
  <RegistryVatPositionsPatch xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.SerialOperations.Model">
    <d2p1:CategoryId>0</d2p1:CategoryId>
    <d2p1:CategoryName>String</d2p1:CategoryName>
    <d2p1:KindId>0</d2p1:KindId>
    <d2p1:KindName>String</d2p1:KindName>
  </RegistryVatPositionsPatch>
  <SellCountry>String</SellCountry>
  <SellCountryId>0</SellCountryId>
  <SellFlatNumber>String</SellFlatNumber>
  <SellId>0</SellId>
  <SellIsoCountry>String</SellIsoCountry>
  <SellName>String</SellName>
  <SellPostalCode>String</SellPostalCode>
  <SellStreetName>String</SellStreetName>
  <SellStreetNumber>String</SellStreetNumber>
  <SellTown>String</SellTown>
  <SellVatId>String</SellVatId>
</UpdateInvoicesCommand>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateInvoicesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.SerialOperations.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>
</UpdateInvoicesResponse>