GET
Read many Invoice Item
Return all invoice items available.
Important
Calls to this method must include the cookie .LawPanel.AuthCookie in order to identify you at user level. For more details about authentication please check this link. To obtain the cookie you can use the method Login.
Request URL
Request parameters
string
The name of the entity binded with the Invoice Items. For example, to get Invoice Items from Cases you have to use "File".
string
The ID of the entity with the Invoice Items binded. If you binded with a Case, it should be the Case ID.
(optional)
integer
Take N records. Default value is 10. Max value is 100.
(optional)
integer
Skip N records.
(optional)
string
Filter ID to apply on this endpoint. To get further details about filters click here.
(optional)
string
Filter definition to apply on this endpoint. To get more details about this parameter check Pagination and Filtering.
Request headers
string
Subscription key which provides access to this API.
Response 200
Return all Invoice Items available.
Loading...
{
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"product_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"currency": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"name_short": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"currency_units": {
"type": "integer"
},
"quantity": {
"type": "integer"
},
"taxes": {
"type": "integer"
},
"details": {
"type": "string"
},
"total": {
"type": "integer"
},
"invoice": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"date_time": {
"type": "string"
},
"date_time_due": {
"type": "string"
},
"invoice_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "integer"
},
"description": {
"type": "string"
},
"leading_zeros": {
"type": "string"
},
"prefix": {
"type": "string"
}
}
},
"invoice_number": {
"type": "integer"
},
"client": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"company_registration_number": {},
"contact_name": {},
"contact_email": {},
"contact_number": {},
"contact_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {}
}
},
"billing_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {},
"line2": {},
"line3": {},
"building": {},
"floor_level": {},
"postal_code": {},
"city": {},
"state_province": {},
"region": {},
"country_id": {
"type": "string"
},
"country_name": {}
}
},
"client_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "integer"
},
"name": {
"type": "string"
}
}
}
}
},
"invoice_items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"product_type": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"currency": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"name_short": {
"type": "string"
},
"symbol": {
"type": "string"
}
}
},
"currency_units": {
"type": "integer"
},
"quantity": {
"type": "integer"
},
"taxes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"units": {
"type": "integer"
},
"percent": {
"type": "integer"
}
},
"required": [
"id",
"name",
"description",
"units",
"percent"
]
}
},
"details": {
"type": "string"
},
"paid_out": {
"type": "boolean"
},
"invoice_entity_type": {
"type": "string"
},
"invoice_entity_id": {
"type": "string"
}
},
"required": [
"id",
"code",
"name",
"product_type",
"currency",
"currency_units",
"quantity",
"taxes",
"details",
"paid_out",
"invoice_entity_type",
"invoice_entity_id"
]
}
},
"payments": {
"type": "array",
"items": {}
},
"user": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"user_name": {
"type": "string"
},
"email": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"language_id": {
"type": "string"
},
"language_name": {
"type": "string"
},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
},
"user_role": {
"type": "string"
},
"last_login_date": {
"type": "string"
},
"is_locked_out": {
"type": "boolean"
},
"user_settings": {},
"claims": {
"type": "array",
"items": {}
},
"user_type_id": {
"type": "string"
},
"user_type_name": {}
}
},
"observations": {
"type": "string"
}
}
},
"invoice_entity_type": {
"type": "string"
},
"invoice_entity_id": {
"type": "string"
},
"invoice_entity_text": {}
},
"required": [
"id",
"code",
"name",
"product_type",
"currency",
"currency_units",
"quantity",
"taxes",
"details",
"total",
"invoice",
"invoice_entity_type",
"invoice_entity_id",
"invoice_entity_text"
]
}
}Response 204
This code is returned if the entity doesn't have any Invoice Item.
Loading...