GET
Read Invoice
Returns details about an Invoice.
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
Invoice ID to get details
Request headers
string
Subscription key which provides access to this API.
Response 200
Returns details about an Invoice.
Loading...
{
"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": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"contact_number": {
"type": "string"
},
"contact_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"line3": {
"type": "string"
},
"building": {
"type": "string"
},
"floor_level": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"city": {
"type": "string"
},
"state_province": {
"type": "string"
},
"region": {
"type": "string"
},
"country_id": {
"type": "string"
},
"country_name": {
"type": "string"
}
}
},
"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": {
"enable": {
"type": "boolean"
},
"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"
},
"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_yoti": {
"type": "boolean"
},
"is_locked_out": {
"type": "boolean"
},
"yoti_id": {},
"user_settings": {},
"claims": {
"type": "array"
},
"user_type_id": {
"type": "string"
},
"user_type_name": {}
}
},
"observations": {
"type": "string"
}
}
}