POST
Create Invoice Item
Create a new invoice item.
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 headers
string
Subscription key which provides access to this API.
Request body
Payload must contain information about the new Invoice Item.
- string Required invoice_entity_type: A string with the type of entity where the new Invoice Item will be associated. For example, to add the new Invoice Item inside a Case you must use the string "File".
- string Required invoice_entity_id: The ID of the entity where the new Invoice Item wil be associated. If you want to bind the Invoice Item with a Case, you have to use the Case ID here.
- string Required currency_id: The Currency ID for the invoice item. To get a list of currencies available please check this link.
- array Optional taxes: Has this item taxes?, if so, this property should contains the Taxes ID. To get a list of taxes available please check this link.
Loading...
{
"type": "object",
"properties": {
"invoice_entity_id": {
"type": "string"
},
"invoice_entity_type": {
"type": "string"
},
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"details": {
"type": "string"
},
"currency_id": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"currency_units": {
"type": "integer"
},
"taxes": {
"type": "array",
"items": {
"type": "string"
}
}
},
"example": {
"invoice_entity_id": "53620e77-5e3b-431b-9cb0-ac2800eaac75",
"invoice_entity_type": "File",
"code": "001",
"name": "Item 001",
"details": "This is a fee item for a Case",
"currency_id": "14e294cf-7425-422f-83f2-a6b20003f5e3",
"quantity": 1,
"currency_units": 100,
"taxes": [
"1db77783-9e48-4ddc-a665-a6b4002671c1"
]
}
}
Response 201
This code is returned when the Invoice Item was created successfully.
Loading...
{
"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"
}
}
}