LEDES XML 2.1 Format
This section describes fields that make up a single row in a LEDES XML E-Billing 2.1 file.
@FIRM
This segment includes the name, address, and contact information about the firm(s) generating the file. Each file should begin with the @FIRM segment.
You can submit more than one firm in the same invoice file by including one or more segments per file. The @FIRM segment includes the @CLIENT segment.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
lf_office_id |
NO |
lf_tax_id (XML 2000) |
string/25 |
A value that uniquely identifies the office. Depending on the location of the office, this value could be the office's tax id number, the office's VAT registration number, the office's DUNS number, the office's business registration number, or any other number to uniquely identify the office, preferably to its local taxing or governmental authority. |
lf_id |
NO |
LAW_FIRM_ID (1998) |
string/20 |
An optional field the law firm assigns to themselves to identify the firm. |
lf_name |
NO |
LAW_FIRM_NAME (1998BI) |
string/120 |
The name of the law firm. |
@lf_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
@lf_remit_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
@lf_billing_contact |
NO |
|
N/A |
A contact structure. See the @CONTACT_INFO segment of this section. |
source_app |
NO |
|
string/25 |
The name of the program that generates this invoice. E.g. Elite |
app_version |
NO |
|
string/10 |
The version of the source_app. E.g. 9.3b |
firm_URL |
NO |
|
string/255 |
The law firm's website URL. Should always begin "http://www. ..." |
file_item_nbr |
NO |
|
Integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @FIRM segment. See the @EXTEND_HEADER segment of this section. |
@TAX
You can include zero or more segments for each type of tax for the invoices in the file.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tx_id |
NO |
|
string/20, Unique |
A unique identifier associated with the tax/rate/jurisdiction that the law firm assigns. |
tax_id_number |
NO |
|
string/30 |
Tax ID number for the law firm or office associated with the specific tax. |
tax_type |
YES |
LINE_ITEM_TAX_TYPE (1998) |
string/30 |
Type of tax. Based on a value specified by the client. Examples in US: "Federal", "State", "Local". Examples in Canada: "GST", "HST", "PST", "TVQ". |
tax_rate_percent |
YES |
tax_rate (XML 2000) and LINE_ITEM_TAX_TOTAL (1998) |
decimal (1.4) |
Percentage tax rate against charge, i.e. 7.25% tax_rate_percent would be represented as "0.0725". |
taxing_jurisdiction_country |
NO |
EW |
string/3 |
The country of the taxing jurisdiction. Use the ISO 3166 country code. |
taxing_jurisdiction_locality |
NO |
taxing_jurisdiction (XML 2.0) |
string/40 |
The locality of the taxing jurisdiction. |
tax_on_tax |
NO |
|
string/1, "Y" or "N" |
One or more taxes in a tax jurisdiction based on the sum of the corresponding invoice line item totals and any other tax amounts previously applied to those line item totals. |
tax_on_tax_id |
NO |
|
string/20, unique |
The tx_id of the tax included in the tax calculation for the current tx_id. |
increase_decrease |
YES |
|
string/8, "Increase" or "Decrease" |
Identifies whether the tax results in increasing or decreasing the matter/invoice. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@CLIENT
This segment includes the name, address, and contact information for a client and point of contact within a client.
You can submit more than one billed client in the same invoice file by including one or more segments per firm. The @CLIENT segment includes the @INVOICE segment.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
cl_id |
YES |
CLIENT_ID (1998) |
string/20 |
The law firm, client, or third party assigned client code. |
cl_lf_id |
NO |
|
string/20 |
A Office ID that uniquely identifies the law firm, as specified by the client. For example, the law firm's tax ID number or other value used by the client to uniquely identify the law firm. Values required in this field may vary from client to client, but within a client's e-billing implementation, only one such unique ID is allowed per law firm. Some client AP systems maintain multiple office IDs for a law firm that could be, for example, location dependent. It is not intended that multiple lf_office_ids for the same law firm be supported by this field, as they would be impossible to program into the law firm's time and billing software. Clients must choose only one unique identifier per law firm to be used in this field. |
cl_name |
NO |
CLIENT_NAME (1998BI) |
string/120 |
The name of the client as required by the client in the electronic submission. |
@cl_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
@client_contact |
NO |
|
N/A |
A contact structure. See the @CONTACT_INFO segment of this section. |
cl_tax_id |
NO |
CLIENT_TAX_ID (1998BI) |
string/20 |
The client's tax ID number used to charge law firm taxes. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @CLIENT segment. See the @EXTEND_HEADER segment of this section. |
@INVOICE
This segment includes details about the invoice.
You can submit one or more invoices for each client by including one or more segments per client. The @INVOICE segment includes the @MATTER and @REGULATORY_STATEMENT segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
inv_id |
YES |
INVOICE_NUMBER (1998) |
string/20 |
The invoice number or code assigned to the billing firm. Multiple invoice IDs can be billed in the same LEDES file. Typically, you can only bill one invoice ID per client ID in each LEDES file. |
inv_date |
YES |
INVOICE_DATE (1998) |
YYYYMMDD |
The invoice date. |
inv_due_date |
NO |
|
YYYYMMDD |
The date assigned to the law firm by which the client must pay the invoice. |
inv_currency |
YES |
INVOICE_CURRENCY (1998) |
string/3 |
The currency for this invoice. |
inv_other_iso |
YES |
INVOICE_TAX_CURRENCY (1998) |
string/3 |
Must match the inv_currency field. Represents the ISO other than the currency used for this invoice. |
inv_start_date |
YES |
BILLING_START_DATE (1998) |
YYYYMMDD |
The starting date for the billing period. |
inv_end_date |
YES |
BILLING_END_DATE (1998) |
YYYYMMDD |
The ending date for the billing period. |
inv_desc |
YES |
INVOICE_DESCRIPTION (1998) |
string/2048 |
A descriptive summary of performed work. |
tax_invoice_cl_name |
NO |
|
string/120 |
The name of the party paying VAT on the invoice. |
@tax_invoice_cl_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
tax_invoice_cl_id |
NO |
|
string/20 |
The tax ID number for the tax_invoice_cl_name field. |
bill_to_cl_name |
NO |
|
string/120 |
The name of the party billed on the invoice. |
@bill_to_cl_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
bill_to_cl_id |
NO |
|
string/20 |
The tax id number for the @bill_to_cl_name field. |
payable_by_cl_name |
NO |
|
string/120 |
The name of the party paying the invoice. |
@payable_by_cl_address |
NO |
|
N/A |
An address structure. See the @ADDRESS_INFO segment of this section. |
payable_by_cl_id |
NO |
|
string/20 |
The tax id number for the payable_by_cl_name field. |
tax_point_date |
NO |
|
date (YYYY-MM-DD) |
The financial period in which the tax applies, generally the invoice date. |
tax_invoice |
NO |
|
string/30, "This is a Tax Invoice" or "This is not a Tax Invoice" |
Indicates whether or not the invoice is a tax invoice. |
credit_note |
NO |
|
string/1, "Y" or "N" |
Indicates whether an instrument is a credit note if it corrects a tax invoice. |
inv_reference |
NO |
|
string/20 |
If the firm is submitting a credit note or an invoice that corrects an invoice previously rejected, enter the inv_id of the original invoice. |
inv_payment_terms |
NO |
|
string/8 (NN.NN/NN) |
Discount applied to the invoice paid within the stated number of days. |
inv_total_tax |
NO |
INVOICE_TAX_TOTAL (1998) |
decimal (money w/ 4 decimal precision) |
The sum of @MATTER.matter_tax_on_fees + @MATTER. matter_tax_on_exp for this inv_id. |
inv_total_tax_other_iso |
NO |
INVOICE_REPORTED_TAX_TOTAL (1998) |
decimal (money w/ 4 decimal precision) |
For mixed currency situations only where it is mandated you must report the total tax in a different currency ISO. The sum of all @MATTER.matter_tax_on_fees + @MATTER.matter_tax_on_exp for this inv_id in the ISO required by law. |
inv_total_net_due |
YES |
INVOICE_TOTAL (1998) |
money (w/ 4 decimal precision) |
The sum of all @Matter.matter_total_due for this inv_id. |
inv_total_net_due_other_iso |
NO |
|
decimal (money w/ 4 decimal precision) |
For mixed currency situations only where it is mandated you must report the total invoice in a different currency ISO. The sum of all @MATTER.matter_total_due for this inv_id. |
inv_image_file_name |
NO |
|
string/255 |
Indicates the name of the file with this invoice image so that the client can locate it. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @INVOICE segment. See the @EXTEND_HEADER segment of this section. |
@REGULATORY_STATEMENT
This segment contains local, regional, or national regulations that require specific information on electronic invoices. You can include zero or more regulatory statements per invoice.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
regulation_heading |
NO |
|
string/500 |
The citation of the statute or regulation associated with the information provided in the next field. |
regulatory_statement |
NO |
|
string/2000 |
The language required by statute or regulation that a law firm provides on an electronic invoice. |
file_item_nbr |
NO |
|
integer, unique |
The item count of this data element in the invoice file submission. |
@MATTER
This segment identifies the matter/case information, associates it with the client and firm matter IDs, and contains aggregation totals.
You can submit each matter (cl_matter_id/lf_matter_id) billed to the invoice by including one or more segments per invoice. The @MATTER segment includes the @TAX_SUMMARY, @MATTER_DISC_CRED, @TKSUM, @FEE, and @EXPENSE segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
cl_matter_id |
YES |
CLIENT_MATTER_ID (1998) |
string/25 |
The client assigned matter ID or case reference number. You can include multiple cl_matter_id's in the same invoice. |
lf_matter_id |
NO |
LAW_FIRM_MATTER_ID (1998) |
string/25 |
The matter code assigned to the law firm. You can include multiple lf_matter_id's in the same invoice. |
matter_name |
NO |
MATTER_NAME (1998BI) |
string/50 |
The descriptive name of the matter, e.g. "Jones v. Davidson", "Jamison Contract Proposal" |
matter_desc |
NO |
|
string/4096 |
Description of the work performed this period. |
po_number |
YES (optional) |
PO_NUMBER (1998) |
string/100 |
The alphanumeric, client_assigned purchase order number or code. |
account_type |
YES (optional) |
ACCOUNT_TYPE (1998BI) |
string/1, "O" or "T" (own account or third party) |
An identifier indicating the account type. |
@lf_managing_contact |
NO |
|
N/A |
A contact structure. See the @CONTACT_INFO segment of this section. |
@lf_contact |
NO |
|
N/A |
A contact structure. See the @CONTACT_INFO segment of this section. |
@cl_contact |
NO |
|
N/A |
A contact structure. See the @CONTACT_INFO segment of this section. |
matter_billing_type |
NO |
|
string/4 "CT" (Contingency Fee), "FF" (Flat Fee), "GW" (Goodwill Work), "MPF" (Multi-Payor Fees), "TM" (Time & Materials), "" (defaults to TM) |
Code indicating how to bill the matter. |
matter_final_bill |
NO |
|
string/1 "Y" or "N" |
Field that specifies whether this bill is final for the matter_id. A null value "" is treated as "N". |
matter_total_detail_fees |
NO |
|
money (w/ 4 decimal precision) |
Sum of all @Fee.Total_Amounts billed to this matter in this invoice. |
matter_total_detail_exp |
NO |
|
money (w/ 4 decimal precision) |
Sum of all @Expense.Total_Amounts billed to this matter in this invoice. |
matter_disc_credit_fees |
YES |
matter_adj_on_fees (XML 2000) and LINE_ITEM_TOTAL (1998) |
decimal (money w/ 4 decimal precision) |
Sum of @MATTER_DISC_CRED.disc_credit_amount, where @MATTER_DISC_CRED.disc_credit_type equals "FEE" and (@MATTER_DISC_CRED.disc_cred is not "MISF", "MIDB", or "MIFA"). |
matter_disc_credit_exp |
YES |
matter_adj_on_exp (XML 2000) and LINE_ITEM_TOTAL (1998) |
decimal (money w/ 4 decimal precision) |
Sum of @MATTER_DISC_CRED.disc_credit_amount, where @MATTER_DISC_CRED.disc_credit_type equals "EXP" and (@MATTER_DISC_CRED.disc_cred is not "MISF", "MIDB", or "MIFA"). |
matter_disc_cred_total |
NO |
|
decimal (money w/ 4 decimal precision) |
matter_disc_credit_total = matter_disc_credit_fees + matter_disc_credit_exp. Represents the total of all discounts or credits applied to the matter/invoice, exclusive of reductions that are the result of fees shared with another client of the law firm. |
matter_perc_shar_fees |
YES |
|
decimal (1.4) |
@MATTER_DISC_CRED.disc_cred_percent, where @MATTER_DISC_CRED.disc_credit_type equals "Percent" and @MATTER_DISC_CRED.disc_credit_category equals "Fee" and @MATTER_DISC_CRED.disc_cred equals "MISF" |
matter_perc_share_exp |
YES |
|
decimal (1.4) |
@MATTER_DISC_CRED.disc_cred_percent, where @MATTER_DISC_CRED.disc_credit_type equals "Percent" and @MATTER_DISC_CRED.disc_credit_category equals "Exp" and @MATTER_DISC_CRED.disc_cred equals "MISF" |
matter_disc_bill_pct_fees |
NO |
|
decimal (1.4) |
@MATTER_DISC_CRED.disc_cred_percent, where @MATTER_DISC_CRED.disc_credit_type equals "Percent" and @MATTER_DISC_CRED.disc_credit_category equals "Fee" and @MATTER_DISC_CRED.disc_cred equals "MIDB" |
matter_disc_bill_pct_exp |
NO |
|
decimal (1.4) |
@MATTER_DISC_CRED.disc_cred_percent_exp, where @MATTER_DISC_CRED.disc_credit_type equals "Percent" and @MATTER_DISC_CRED.disc_credit_category equals "Exp" and @MATTER_DISC_CRED.disc_cred equals "MIDB" |
matter_tax_on_fees |
NO |
|
decimal (money w/ 4 decimal precision) |
Sum of all @TAX_SUMMARY.total_tax_on_fees for matter/invoice. |
matter_tax_on_exp |
NO |
|
decimal (money w/ 4 decimal precision) |
Sum of all @TAX_SUMMARY.total_tax_on_expense for matter/invoice. |
matter_net_fees |
NO |
|
decimal (money w/ 4 decimal precision) |
matter_net_fees = (matter_total_detail_fees + matter_disc_credit_fees) * matter_perc_shar_fees + matter_tax_on_fees |
matter_net_exp |
NO |
|
decimal (money w/ 4 decimal precision) |
matter_net_exp = (matter_total_detail_exp + matter_disc_credit_exp) * matter_perc_shar_exp + matter_tax_on_exp) |
matter_funds_applied |
NO |
|
decimal (money w/ 4 decimal precision) |
Sum of all @MATTER_DISC_CRED.disc_cred_amount where disc_cred equals "MIFA" |
matter_total_due |
NO |
|
money (w/ 4 decimal precision) |
Net_fees + Net_exp |
associated_line_items |
NO |
|
string/1, "Y" or "N" |
Indicates if there are any fee or children of fee line items or expense or children of expense line items associated with this invoice. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @MATTER segment. See the @EXTEND_HEADER segment of this section. |
@TAX_SUMMARY
This segment summarizes the total of items taxed and the tax applied to those items for a matter.
You submit one tax summary for each tx_id (in the @FEE and @EXPENSE segments) by including zero or more segments per matter.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tx_id |
YES |
|
string/20 |
A unique identifier associated with the tax/rate/jurisdiction. Refers to @TAX.tx_id value. Could be many @TAX_SUMMARY.tx_id entries per matter/invoice. |
tax_total_detail_fees |
NO |
|
decimal (money w/ 4 decimal precision) |
Total taxable amount of fees attributable to this tx_id. tax_total_detail_fees = ((Sum of all @FEE.total_amounts where @TAX_ITEM_FEE.tx_id for the item equals this @TAX_SUMMARY.tx_id) + (sum of all @MATTER_DISC_CRED.disc_cred_amount where disc_cred_category = ""Fee"" and @TAX_MATTER_DISC_CRED.tx_id equals this @TAX_SUMMARY.tx_id)) * @MATTER.matter_perc_shar_fees on this matter/invoice. Certain taxes are calculated not only on line items, but also include another tax for these line items -- a "tax on tax" situation. For example, in Canada both Quebec and Prince Edward Island have specific taxes calculated on the sum of the line items, plus the federal tax paid on those line items. In these situations, the tax_total_detail_fees figure stated should include the other tax attributable to the line items so that the math statement for total_tax_on_fees is correct. |
total_tax_on_fees |
YES |
|
decimal (money w/ 4 decimal precision) |
Total of tax due on tax_total_detail_fees for this tx_id. |
tax_total_detail_expense |
NO |
|
decimal (money w/ 4 decimal precision) |
Total taxable amount of expenses attributable to this tx_id. tax_total_detail_expense = ((Sum of all @EXPENSE.total_amounts where @TAX_ITEM_FEE.tx_id for the item equals this @TAX_SUMMARY.tx_id) + (sum of all @MATTER_DISC_CRED.disc_cred_amount where disc_cred_category = "Exp" and @TAX_MATTER_DISC_CRED.tx_id equals this @TAX_SUMMARY.tx_id)) * @MATTER.matter_perc_shar_exp on this matter/invoice. Certain taxes are calculated not only on line items, but also include another tax for these line items -- a "tax on tax" situation. For example, in Canada both Quebec and Prince Edward Island have specific taxes calculated on the sum of the line items, plus the federal tax paid on those line items. In situations like this, the tax_total_detail_exp figure stated should include the other tax attributable to the line items so that the math statement for total_tax_on_fees is correct. |
total_tax_on_expense |
YES |
|
decimal (money w/ 4 decimal precision) |
Total taxable amount of expenses attributable to this tx_id. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@MATTER_DISC_CRED
This segment summarizes adjustments (discounts, credits, etc.) made to the invoice at the matter level.
You submit one segment for each professional fee charge by including zero or more segments per matter. The @MATTER_DISC_CRED includes the @TAX_MATTER_DISC_CRED segment.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
disc_cred |
NO |
|
string/5 "MIA" (Matter/Invoice Adjustment), "MIB" (Matter/Invoice Bonus), "MICF" (Matter/Invoice Contingency Fee), "MICM" (Matter/Invoice Credit Memo), "MIDB" (Matter/Invoice Discounted Bill), "MIDHR" (Matter/Invoice Discounted Hourly Rate), "MIFA" (Matter/Invoice Funds Applied), "MIFF" (Matter/Invoice is billed at a Flat Fee), "MIF" (Matter/Invoice Retainer), "MISF" (Matter Invoice Shared Fee), "Other" |
Used to track discounts and credits that the law firm may need to submit on the matter/invoice. |
disc_cred_note |
NO |
|
string/255 |
Identification of the discount or credit identified in the disc_credit field as "Other", using codes specified by the client. |
disc_cred_type |
NO |
|
string/8, "Percent" or "Flat" |
Type of discount or credit applied to the matter/invoice. |
disc_cred_category |
NO |
|
string/3 "Fee" or "Exp" |
An indicator of whether the discount or credit applies to fees ("Fee") or expenses ("Exp"). |
increase_decrease |
NO |
|
string/8, "Increase" or "Decrease" |
Identifies whether the disc_cred results in increasing the cost of the matter/invoice (and is therefore a charge applied at the matter/invoice-level) or decreasing the cost of the matter/invoice (and is therefore a reduction applied at the matter/invoice level). |
pre_post_split |
NO |
|
string/10, "Pre-Split", "Post-Split", "NA" |
Identifies whether the disc_cred is applied before ("Pre-Split") or after ("Post-Split) the MISF and MIDB percentages are applied to the invoice. |
discount_percent |
NO |
|
decimal (1.4) |
A percentage number expressing the percent discount applied to this matter/invoice, i.e. "0.15" reflects a 15% discount to the matter/invoice. This value is always a reduction to the invoice. |
disc_cred_amount |
YES |
|
decimal (money w/ 4 decimal precision) |
The total amount discounted/credited against or additional charges incurred for this disc_cred. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @MATTER_DISC_CRED segment. See the @EXTEND_HEADER segment of this section. |
@TAX_MATTER_DISC_CRED
This segment identifies taxes applied to the adjustment in @MATTER_DISC_CRED.
You submit one segment for each type of tax by including zero or more segments per @MATTER_DISC_CRED.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tx_id |
YES |
string/20 |
Taxes relevant to the fee item. Refers to the @TAX.tx_id value. Could be many @TAX_ITEM_FEE.tx_id entries per @MATTER_DISC_CRED.disc_cred item. |
|
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@TKSUM
This segment includes the name, level, and rate that timekeepers bill on the invoice.
You can submit one or more timekeepers for each matter by including one or more segments per matter.
Note: If the timekeeper bills at two different rates or two different levels on the same invoice, this section would have more than one rate or level for the timekeeper.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tk_id |
YES |
TIMEKEEPER_ID (1998) |
string/10 |
Unique ID of a person billed on this matter. The same tk_id may appear multiple times if the timekeeper's name, level, or rate changes during the billing period. The firm assigns this value, and it should remain the same for a biller for all work done within the firm (could be biller initials if the biller initials are unique across that firm). |
tk_lname |
NO |
TIMEKEEPER_LAST_NAME (1998) |
string/30 |
The last name of the timekeeper. |
tk_fname |
NO |
TIMEKEEPER_FIRST_NAME (1998) |
string/20 |
The first name of the timekeeper. |
tk_level |
NO |
TIMEKEEPER_CLASSIFICATION (1998) |
string/15 |
The level of the timekeeper. Valid values include the following: •Partner •Associate •Of Counsel •Paralegal •Legal Assistant •Secretary •Clerk •Other |
tk_rate |
NO |
LINE_ITEM_UNIT_COST (1998) |
decimal (money w/ 4 decimal precision) |
The contracted hourly rate the timekeeper bills for this matter prior to any discounts or adjustments, e.g. "120.0000" Note: It is possible for a timekeeper to bill at more than one tk_rate during a given invoice period. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @TKSUM segment. See the @EXTEND_HEADER segment of this section. |
@FEE
This segment identifies individual fee charges.
You can submit amounts for each professional fee charge by including one or more segments per invoice. The @FEE segment includes the @FEE_ITEM_DISC_CRED and @TAX_ITEM_FEE segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
charge_date |
YES |
LINE_ITEM_DATE (1998) |
YYYYMMDD |
Date of the service. |
tk_id |
YES |
TIMEKEEPER_ID (1998) |
string/10 |
Unique ID for the person performing the service billed for this line item. |
tk_level |
NO |
TIMEKEERP_CLASSIFICATION (1998) |
string/15 |
The level of the timekeeper. Valid values include Partner, Associate, Of Counsel, Paralegal, Legal Assistant, Secretary, Clerk, and Other. |
work_location_country |
NO |
|
string/3 |
The country where work associated with the fee item was performed. Use ISO 3166 country code set forth by International Standards Organization (www.iso.org). |
work_location_locality |
NO |
fee_work_location (XML 2.0) |
string/40 |
The location where work associated with the fee item was performed to support the taxes appearing in the @TAX_ITEM_FEE Segment. |
charge_desc |
YES |
LINE_ITEM_DESCRIPTION (1998) |
string/15K |
Narrative description of the service provided for this line item. |
task_code |
YES |
acca_task (XML 2000) and LINE_ITEM_TASK_CODE (1998) |
string/4 |
Task code for this line item, e.g., L110. Only one code per line item. |
task_activity |
YES |
acca_activity (XML 2000) and LINE_ITEM_ACTIVITY_CODE (1998) |
string/4 |
Activity code for this line item, e.g. A101. Only one code per line item. |
charge_type |
YES |
|
string/1 |
U=unit price, F=fixed charge If charge_type is "U", then base_amount = hours * rate. (There is now a client setting to enable or disable charge_type = F.) |
units |
YES |
LINE_ITEM_NUMBER_OF_UNITS (1998) |
float (4.2) (NN.NN) |
Hours billed to this line item, e.g. "3.4". (Use "0.0" for fixed charge) |
rate |
YES |
LINE_ITEM_UNIT_COST (1998) |
float (10.4) (NNNNNN.NNNN) |
The timekeeper rate for this line item, e.g. "120.00" (Use "0.0" for fixed charge) |
base_amount |
NO |
|
float (12.4) |
If charge_type is "U", then base_amount = hours * rate. If charge type is "F", then base_amount is a fixed amount. E.g. "300.00". |
item_disc_cred_amount |
YES |
discount_amount (XML 2000) and LINE_ITEM_ADJUSTMENT_AMOUNT (1998) |
decimal (money w/ 4 decimal precision) |
Sum of all @FEE_ITEM_DISC_CRED.disc_cred_amounts for this fee item. |
total_amount |
NO |
|
decimal (money w/ 4 decimal precision) |
The final billed value of the fee items after application of all @FEE_ITEM_DISC_CRED.disc_cred_amounts. Does not include @MATTER_DISC_CRED.disc_cred_amounts or taxes on the fee item.@FEE.total_amount = @FEE.base_amount + @FEE.item_disc_cred_amount |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @FEE segment. See the @EXTEND_HEADER segment of this section. |
@FEE_ITEM_DISC_CRED
This segment summarizes adjustments (discounts, credits, etc.) made to the invoice at the fee item level.
You submit one segment for each fee item by including zero or more segments per matter.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
disc_cred |
NO |
|
string/5 Valid values are FID, FIFF, FIA, FIDHR, Other |
The disc_credit field tracks discounts and credits that the law firm may need to submit on the fee item. FID (Fee Item Discount - client receives a percentage discount that is assessed at the fee item level), FIFF (Fee Item is billed at a Flat Fee), FIA (Fee item Adjustment - a flat adjustment (reduction or credit) applied to the fee item), FIDHR (Fee Item Discounted Hourly Rate - the discounted hourly rate applied to the fee item), or OTHER. |
disc_cred_note |
NO |
|
string/255 |
Identification of the discount or credit identified in the disc_credit field as "Other"", using codes specified by the client. |
disc_cred_type |
YES* *Only works with flat fees |
@FEE.discount_type |
string/8, "Percent" or "Flat" |
Type of discount or credit applied to the fee item. |
increase_decrease |
NO |
NEW |
string/8, "Increase" or "Decrease" |
Identifies whether the disc_cred results in increasing the cost of the fee item or decreasing the cost of the fee item. |
discount_percent
|
YES*
*Not currently working |
@FEE.discount_percent |
decimal (1.4) |
A percentage number expressing the percent discount provided to this charge, i.e., 0.15 reflects a 15% discount to the charge. This value is always a reduction to the invoice. |
disc_cred_amount |
YES |
@FEE.discount_amount and LINE_ITEM_ADJUSTMENT_AMOUNT (1998) |
decimal (money w/ 4 decimal precision) |
The total amount discounted or credited for this disc_cred. Discounts or reductions should be a negative number; credits should be a positive number. i.e., -150.0000 reflects a $150 disc_cred, 150.0000 reflects a $150 credit. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@TAX_ITEM_FEE
This segment identifies taxes applied to the adjustment in @FEE.
You can submit a segment for a fee item by including zero or more segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tx_id |
NO |
|
string/20 |
Taxes relevant to the fee item. Refers to the @TAX.tx_id value. Could be many @TAX_ITEM_FEE.tx_id entries per fee item. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@EXPENSE
This segment identifies individual expense charges.
You can submit amounts for each expense charge by including one or more segments per invoice. The @EXPENSE segment includes the @EXPENSE_ITEM_DISC_CRED and @TAX_ITEM_EXPENSE segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
charge_date |
YES |
LINE_ITEM_DATE (1998) |
date (YYYY-MM-DD) |
Date of the service. |
tk_id |
YES |
TIMEKEEPER_ID (1998) |
string/10 |
Unique ID for the timekeeper. |
tk_level |
NO |
TIMEKEEPER_CLASSIFICATION (1998) |
string/15 |
The level of the timekeeper. Valid values include Partner, Associate, Of Counsel, Paralegal, Legal Assistant, Secretary, Clerk, and Other. |
work_location_country |
NO |
|
string/3 |
The country where work associated with the expense was performed. Use the ISO 3166 country code set forth by International Standards Organization (www.iso.org). |
work_location_locality |
NO |
work_location (XML 2.0) |
string/40 |
The location where work associated with the expense was performed to support the taxes appearing in the @TAX_ITEM_EXPENSE s. |
charge_desc |
YES |
LINE_ITEM_DESCRIPTION (1998) |
string/15K |
Narrative description of the expense charged by this line item. |
task_code |
YES |
acca_task (XML 2000) and LINE_ITEM_TASK_CODE (1998) |
string/4 |
Task code for this line item, e.g., L110. Only one code per line item. |
expense_code |
YES |
acca_expense (XML 2000) and LINE_ITEM_EXPENSE_CODE (1998) |
string/4 |
Expense code for this line item, e.g.,E101. Only one code per line item. |
charge_type |
NO |
|
string/1 |
U=unit price, F=fixed charge |
units |
YES |
LINE_ITEM_NUMBER_OF_UNITS (1998) |
decimal (4.2) (NNNN.NN) |
Quantity of units billed to this line item. |
rate |
YES |
LINE_ITEM_UNIT_COST (1998) |
decimal (money w/ 4 decimal precision) |
Rate for this line item. |
base_amount |
NO |
|
decimal (money w/ 4 decimal precision) |
The original WIP value of the expense entry before adjustments or discounts of any sort apply. If charge_type is U, then base_amount = units * rate prior to any adjustments or discounts. If charge type is F, then base_amount is a fixed amount. e.g., 300.0000. |
item_disc_cred_amount |
YES |
discount_amount (XML 2000) and LINE_ITEM_ADJUSTMENT_AMOUNT (1998) |
decimal (money w/ 4 decimal precision) |
Total of all @EXPENSE_ITEM_DISC_CRED.disc_cred_amount for this expense item. Does not include @MATTER_DISC_CRED.disc_cred_amounts. |
total_amount |
NO |
|
decimal (money w/ 4 decimal precision) |
The final billed value of the expense entry after the application of all @EXPENSE_ITEM_DISC_CRED.disc_cred_amount. Does not include @MATTER_DISC_CRED.disc_cred_amounts or taxes on the expense item @EXPENSE.total_amount = @EXPENSE.base_amount + @EXPENSE.item_disc_cred_amount |
payee_name |
NO |
|
string/120 |
The name of the payee for the expense item. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@extend_header |
NO |
|
N/A |
Adds additional extensions to the @EXPENSE segment. See the @EXTEND_HEADER segment of this section. |
@EXPENSE_ITEM_DISC_CRED
This segment summarizes adjustments (discounts, credits, etc.) made to the invoice at the expense item level.
You submit one segment for each expense item by including zero or more segments per matter.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
disc_cred |
NO |
|
string/5 |
The disc_credit field tracks discounts and credits that the law firm may need to submit on the expense item. Valid values include the following:
|
disc_cred_note |
NO |
|
string/255 |
An explanation of the discount or credit, using codes the client specifies. |
disc_cred_type
|
YES*
*Only works with flat fees |
@EXPENSE.discount_type (XML 2000) |
string/8 |
Type of discount or credit applied to the expense item. Valid values are Percent and Flat. |
increase_decrease |
NO |
|
string/8, "Increase" or "Decrease" |
Identifies whether the disc_cred results in increasing the cost of the fee item or decreasing the cost of the fee item. |
disc_cred_percent
|
YES*
*Not currently working |
@EXPENSE.discount_percent (XML 2000) |
decimal (1.4) |
A percentage number expressing the percent discount provided to this charge, i.e., 0.15 reflects a 15% discount to the charge. This value is always a reduction to the invoice. |
disc_cred_amount |
YES |
@EXPENSE.discount_amount (XML 2000) and LINE_ITEM_ADJUSTMENT_AMOUNT (1998) |
decimal (money w/ 4 decimal precision) |
The total amount discounted or credited for this disc_cred. Discounts or reductions should be a negative number; credits should be a positive number. I.e., -150.0000 reflects a $150 discount, 150.0000 reflects a $150 credit. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@TAX_ITEM_EXPENSE
This segment identifies taxes applied to the adjustment in @EXPENSE.
You can submit a segment for an expense item by including zero or more segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
tx_id |
NO |
|
string/20 |
Taxes relevant to the expense item. Refers to the @TAX.tx_id value. Could be many @TAX_ITEM_EXPENSE.tx_id entries per expense item. |
file_item_nbr |
NO |
|
integer, Unique |
The item count of this data element in the invoice file submission. |
@ADDRESS_INFO
This section applies to the @LF_ADDRESS, @LF_REMIT_ADDRESS, and @CL_ADDRESS segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
address_1 |
NO |
LAW_FIRM_ADDRESS_1 (1998) and CLIENT_ADDRESS_1 (1998) |
string/60 |
The street address of the parent segment. |
address_2 |
NO |
LAW_FIRM_ADDRESS_2 (1998) and CLIENT_ADDRESS_2 (1998) |
string/60 |
Optional second street address of the parent segment. |
address_3 |
NO |
|
string/60 |
Optional third street address of the parent segment. |
city |
NO |
LAW_FIRM_CITY (1998) and CLIENT_CITY (1998) |
string/40 |
The city of the parent segment. |
state_province |
NO |
LAW_FIRM_STATEorREGION (1998) and CLIENT_STATEorREGION (1998) |
string/40 |
The state or province of parent segment. Required except in countries without an equivalent address component. Use accepted abbreviations mandated by the parent country's postal service. |
zip_postal_code |
NO |
LAW_FIRM_POSTCODDE (1998) and CLIENT_POSTCODE (1998) |
string/20 |
The postal code of parent segment. Required except in countries without an equivalent address component. |
country |
NO |
LAW_FIRM_COUNTRY (1998) and CLIENT_COUNTRY (1998) |
string/3 |
The country of parent segment. Use the ISO 3166 country code set forth by International Standards Organization (www.iso.org). |
phone |
NO |
|
string/20 |
The phone number of the parent segment. |
fax |
NO |
|
string/20 |
The fax number of the parent segment. |
file_item_number |
NO |
|
integer, unique |
The item count of this data element in the invoice file submission. |
@CONTACT_INFO
This section applies to the @LF_BILLING_CONTACT, @LF_MANAGING_CONTACT, @LF_CONTACT, @CLIENT_CONTACT and @CL_CONTACT segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
contact_lname |
NO |
lf_billing_contact_lname (XML 2000) and cl_contact_lname (XML 2000) and lf_managing_contact_lname (XML 2000) and cl_contact_lname (XML 2000) |
string/30 |
The last name of the contact. |
contact_fname |
NO |
lf_billing_contact_fname (XML 2000) and cl_contact_fname (XML 2000) and lf_managing_contact_fname (XML 2000) and cl_contact_fname (XML 2000) |
string/20 |
The first name of the contact. |
contact_id |
NO |
lf_billing_contact_id (XML 2000) and lf_contact_id (XML 2000) and cl_contact_id (XML 2000) |
string/15 |
An ID associated with the contact. |
contact_phone |
NO |
lf_billing_contact_phone (XML 2000) and lf_contact_phone (XML 2000) and cl_contact_phone (XML 2000) |
string/20 |
The phone number of the contact. |
contact_fax |
NO |
lf_billing_contact_fax (XML 2000) |
string/20 |
The fax number of the contact. |
contact_email |
NO |
lf_billing_contact_email (XML 2000) and cl_contact_email (XML 2000) and lf_contact_email (XML 2000) and cl_contact_email (XML 2000) |
string/60 |
The email address of the contact. |
file_item_number |
NO |
|
integer, unique |
The item count of this data element in the invoice file submission. |
@EXTEND_HEADER
This segment adds additional extensions to other segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
office |
NO |
|
string |
Defines the name of a office associated with the data, e.g., E-billing Office or Realestate.com. |
app |
NO |
|
string |
Defines the name of an application associated with the data, e.g., E-billing or Realestate Online. |
sequence |
NO |
|
string |
Defines a sequence of use. |
date |
NO |
|
date (YYYY-MM-DD) |
Defines a date associated with the overall extend_header and associated extend_data elements in this segment. |
@extend_data |
NO |
|
N/A |
Provides the name value pairs. (See the @EXTEND_DATA segment.) |
@EXTEND_DATA
This segment provides name/value pairs to other segments.
Field Name |
Used by Collaborati? |
Previous Field Names |
Data Type/Max Characters |
Description |
---|---|---|---|---|
ext_name |
NO |
|
string |
Provides the name of the variable. |
ext_value |
NO |
|
string |
Provides the value of the variable. |
file_item_nbr |
NO |
|
integer, unique |
The item count of this data element in the invoice file submission. |