DocCloud API

<back to all web services

ListCompanyInvoiceAggregatorsQuery

Requires Authentication
The following routes are available for this service:
GET/invoiceaggregatorList company activated aggregators
BaseResponse<T> Parameters:
NameParameterData TypeRequiredDescription
MultipleResultformIList<T>No
TotalformintNo
OffsetformintNo
BaseSingleResponse<T> Parameters:
NameParameterData TypeRequiredDescription
ResultformTNo
InvoiceAggregatorConfigDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
TypeformintNo
StatusformintNo
ConfigJsonformstringNo
IsActiveformboolNo
SendInvoiceformboolNo
EmailNotificationsformboolNo
SyncStartformDateTimeNo
IsHiddenformboolNo
InvoiceTypeformintNo
InvoiceSchemaIdformuintNo
CompanyDbConfigIdformuintNo
BaseKeyDto Parameters:
NameParameterData TypeRequiredDescription
CreatedByIdformuintNo
ModifiedByIdformuintNo
CreatedDateformDateTimeNo
ModifiedDateformDateTimeNo
IdformuintNo

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.

GET /invoiceaggregator HTTP/1.1 
Host: api.chmuradokumentow.pl 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"total":0,"offset":0,"result":{"name":"String","type":0,"status":0,"configJson":"String","isActive":false,"sendInvoice":false,"emailNotifications":false,"syncStart":"0001-01-01T00:00:00.0000000Z","isHidden":false,"invoiceType":0,"invoiceSchemaId":0,"companyDbConfigId":0,"createdById":0,"modifiedById":0,"createdDate":"0001-01-01T00:00:00.0000000Z","modifiedDate":"0001-01-01T00:00:00.0000000Z","id":0}}