Link Search Menu Expand Document

GetInvoiceHeaders

Overview

Retrieves Invoice Headers from the system based on a set of criteria. The headers contain information about the invoice, but not the actual content of the invoice. The actual content can be retrieved using the GetInvoiceDetails call.

Returns

A list of Invoice Headers meeting the specified criteria.


Request

Name Type Description
billingPeriodDate String Select invoices covering this date. This should be in the format YYYY-MM-DDThh:mm:ssZ.
customerCode String The customerCode to filter on. This works as a contains, that is: if we filter on “1”, a customer with code “12” will also match.
calculatedSinceDate String Select only invoices with a lastCalculatedDate greater than or equal to the date specified here. This should be in the format YYYY-MM-DDThh:mm:ssZ.
includedStatuses InvoiceStatusEnum[] Select only invoices with a status contained in this list.
billingPeriodEndFrom String (Optional) Invoices ending on or after this date.
billingPeriodEndTo String (Optional) Invoices ending before this date.

Response

Name Type Description
ResultMessage String Additional information when operation failed.
ResultCode ResultCodeEnum Whether the operation completed successfully.
Result InvoiceHeader[] Operation result.

Back to top

Copyright Ⓒ 2011-2024 CloudBilling B.V.