API: Premium Invoice
GET /api/v3/premium-invoice
Filtering parameters:
Parameter | Type | IN | Example | Description |
---|---|---|---|---|
ids | string|array | QUERY | filters[ids]=34,55,123 or filters[ids][]=34&filters[ids][]=55 ... | Filtering by premium_invoice id = value (or values) |
policies | string|array | QUERY | filters[policies]=34,55,123 or filters[policies][]=34&filters[policies][]=55 ... | Filtering by policy id = value (or values) |
statuses_invoice | string|array | QUERY | filters[statuses_invoice]=1,2 or filters[statuses_invoice][]=1&filters[policies][]=2 ... | Filtering by premium invoice status id = value (or values) |
API: _ Default behavior #List defaults
Response data:
Metadata: object.
Parameter | Type | Description |
---|---|---|
count | int | Number of all results marching criteria |
status | int | Response status (same as in http code) |
Data: object.data[array]
Parameter | Type | Description |
---|---|---|
id | integer | Premium invoice id |
amount_brutto | string(float)|null | Premium invoice amount brutto |
start_date | string | Premium invoice start date |
end_date | string | Premium invoice end date |
status_invoice | array | Status of invoice |
status_invoice[id] | integer|null | Status id |
status_invoice[name] | string|null | Status name in DE language |
status_invoice[name_e] | string|null | Status name in EN language |
status_invoice[name_i] | string|null | Status name in IT language |
status_invoice[name_f] | string|null | Status name in FR language |
Response (Error):
Parameter | Type | Description |
---|---|---|
code | integer | An error code |
error | string | A message containing some information about the error |
errors | array | List of errors devided by field in associative array {field_name:error message} |
API: _ Default behavior #Authentication defaults
Request
curl -X GET https://public.brokerstar.biz/api/v3/premium-invoice --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "count": "3", "data": [ { "policy": { "id": 3051, "nr": "6881" }, "start_date": "2021-01-01T00:00:00+01:00", "end_date": "2021-12-31T00:00:00+01:00", "amount_brutto": "39394.80", "status_invoice": { "name_e": "Open", "name_f": "Ouvert", "name_i": "Aperto", "id": 1, "name": "Offen" }, "id": 15952 } ], "status": 200 }
Or one of
- API: _ Default behavior #Authentication defaults
- API: _ Default behavior #List defaults
GET /api/v3/premium-invoice/{id}
Request parameter:
Parameter | Type | In | Description |
---|---|---|---|
id | int | url | id of requested policy |
Response data:
Metadata: object.
Parameter | Type | Description |
---|---|---|
status | int | Response status (same as in http code) |
Data: object.data
Parameter | Type | Description |
---|---|---|
All columns from single premium invoice + |
Response (Error):
Parameter | Type | Description |
---|---|---|
code | integer | An error code |
error | string | A message containing some information about the error |
errors | array | List of errors devided by field in associative array {field_name:error message} |
Request
curl -X GET https://public.brokerstar.biz/api/v3/premium-invoice/15953 --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2NTg[...]cm5hbWUiOiJkZW1vLWRlIn0.VTVp[...]cqIg'
Response (Success)
200 OK { "data": { "policy": { "id": 3051, "nr": "6881" }, "start_date": "2022-01-01T00:00:00+01:00", "end_date": "2022-12-31T00:00:00+01:00", "amount_brutto": "39394.80", "status_invoice": { "name_e": "Controlled", "name_f": "Contrôlé", "name_i": "Controllato", "id": 3, "name": "Kontrolliert" }, "id": 15953 }, "status": 200 }
Response (Error)
404 Not found { "error": "Entity not found", "code": 404 }
Or one of
- API: _ Default behavior #Authentication defaults