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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"name":"String","type":0,"sendInvoice":false,"emailNotifications":false,"syncStart":"0001-01-01T00:00:00.0000000Z","invoiceType":0,"invoiceSchemaId":0,"serviceSettings":{}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"verificationDataDto":{"aggregatorTypeSpecificData":"String","aggregatorType":0},"id":0,"code":"FAIL","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"result":{},"isSuccess":false}