BokaMera.API.Host

<back to all web services

GetVossCustomerInvoiceBalance

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
GET/voss/invoice/balanceget voss invoice
GetVossCustomerInvoiceBalance Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
InvoiceDatequeryDateTime?NoControls up to which point of time transactions are included in invoice, can be set to any date, if not provided current UTC time will be used instead
ScheduledStartTimequeryDateTime?NoIf present the operation will start only after this date
RecurringSchedulequerystringYesOptional CRON expression for recurring operations.
VossPagination Parameters:
NameParameterData TypeRequiredDescription
SearchTextformstringNo
PageIndexformintNo
PageSizeformintNo
SortFieldformstringNo
SortDirectionformSortDirectionEnumNo
SortDirectionEnum Enum:
Ascending
Descending

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 /voss/invoice/balance HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}