DocCloud API

<back to all web services

CreateInvoiceAggregatorCommand

Requires Authentication
The following routes are available for this service:
POST/invoiceaggregatorCreate invoice aggregator config
CreateInvoiceAggregatorCommand Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
TypebodyintNo
SendInvoicebodyboolNo
EmailNotificationsbodyboolNo
SyncStartbodyDateTimeNo
InvoiceTypebodyintNo
InvoiceSchemaIdbodyuintNo
ServiceSettingsbodyObjectNo
CreateInvoiceAggregatorResponse Parameters:
NameParameterData TypeRequiredDescription
VerificationDataDtoformVerificationDataDtoNo
PostOperationResult<T> Parameters:
NameParameterData TypeRequiredDescription
IdformTNo
OperationResult Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ResponseStatusformResponseStatusNo
ResultformObjectNo
IsSuccessformboolNo
VerificationDataDto Parameters:
NameParameterData TypeRequiredDescription
AggregatorTypeSpecificDataformstringNo
AggregatorTypeformintNo

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.

POST /invoiceaggregator HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateInvoiceAggregatorCommand xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceAggregator.Command">
  <EmailNotifications>false</EmailNotifications>
  <InvoiceSchemaId>0</InvoiceSchemaId>
  <InvoiceType>0</InvoiceType>
  <Name>String</Name>
  <SendInvoice>false</SendInvoice>
  <ServiceSettings />
  <SyncStart>0001-01-01T00:00:00</SyncStart>
  <Type>0</Type>
</CreateInvoiceAggregatorCommand>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateInvoiceAggregatorResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceAggregator.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>
  <VerificationDataDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/Cloud.Globals.ServiceUtils.GlobalDto.InvoiceAggregator.Model">
    <d2p1:AggregatorType>0</d2p1:AggregatorType>
    <d2p1:AggregatorTypeSpecificData>String</d2p1:AggregatorTypeSpecificData>
  </VerificationDataDto>
</CreateInvoiceAggregatorResponse>