eBillingHub e-Billing Standard Format (eSF) - v2.0.2

 

 

 

Segment / Field Name

Segment, Element or Attribute

Data Type

Description 

Comments

esfdoc

 

-

Top-level e-Billing Standard Format document wrapper.

 

timestamp

Element [0,1]

xs:dateTime

The billing firm's federal tax id. For non-US firms - a code that the firm will use to uniquely identify itself to it's clients. 

 

billing_org

Segment [1]

billingOrgType

The billing_org node contains elements and attributes describing traits and configuration of the law firm with eBH.  

 

payor_orgs/payor_org

Segment [1]
Segment [1,*]

payorOrgType

The payor_org node denotes a collection of 1 or more payor segements

 

taxes/tax

Segment [0,1]
Segment [0,*]

taxType

The tax segements at the esf_doc level are for taxes details refered-to in all subsequent subsections. The tax elements in the subsections refer to the tax nodes at the esf_doc level.

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

billing_org

 

billingOrgType

Detail the name, address, contact information about the firm which has generated the file.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

xs:string

Billing organization self-assigned identifier.

 

ebilling_id

Attribute [1]

xs:string

Unique value to identify the billing_org within their e-billing application.

 

name

Element [1]

xs:string

Name associated with the billing organization.

 

source_app

Element [0,1]

xs:string

The name of the program used to generate this invoice, e.g. "3E".

 

app_version

Element [0,1]

xs:string

The version of the source_app, e.g. "2.8.1".

 

tax_id

Element [1]

xs:string

A value that uniquely identifies the billing organization Depending on the location of the billing organization this value could be the billing organization tax id number, VAT registration number, DUNS number, business registration number, or any other number or used by the billing organization to uniquely identify itself, preferably to its local taxing or governmental authority.

 

firm_url

Element [0,1]

xs:string

The version of the source_app, e.g. "9.3b".

 

address

Segment [1]

addressType

The address segment associated with the billing_org

 

remit_address

Segment [0,1]

addressType

The remit address segment associated with the billing_org

 

contact

Segment [0,1]

contactType

The contact segment details associated with the billing_org

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

payor_org

 

payorOrgType

Detail the name, address, contact information about a client and point of contact within a client that invoices are being sent to.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

string60NoSpace

Billing organization assigned payor organization identifier.

 

ebilling_id

Attribute [0,1]

xs:string

Unique value to identify payor organization (within EBH Application)

 

biller_id

Element [0,1]

xs:string

An identifier, specified by the payor organization, to uniquely identify the billing organization.

 

name

Element [1]

xs:string

Name associated with the payor organization.

 

tax_id

Element [0,1]

xs:string

A value that uniquely identifies the payor organization Depending on the location of the payor organization this value could be the payor organization tax id number, VAT registration number, DUNS number, business registration number, or any other number or used by the payor organization to uniquely identify itself, preferably to its local taxing or governmental authority.

 

invoice

Segment [1]

invoiceType

The invoice segment associated with the payor_org.

 

address

Segment [0,1]

addressType

The address segment associated with the payor_org

 

contact

Segment [0,1]

contactType

 

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

invoice

 

invoiceType

Detail segment identifying the invoice 'header' information regarding detail charges which follow.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

stringNoSpace

The billing organization assigned invoice number or code.

 

has_attachments

Attribute [0,1]

xs:boolean

A flag that determines whether an invoice has attached files.

 

requested_status

Attribute [0,1]

Values: [ 'hold', '' ]

Use this attribute with a value of "Hold". This will stage the invoice in eBillingHub and have it show in the tracking page, for end-users to interact with. They can validate, make required edits and submit the invoice onwards.

 

leadmatter

Attribute [0,1]

xs:string

This is the lead matter in a billing group. If this invoice is not part of a group then this is just the matter on the invoice.

 

date

Element [1]

xs:string

The invoice date.

 

due_date

Element [0,1]

xs:string

The billing organization assigned date by which the invoices is due to be paid by the payor organization.

 

currency

Element [0,1]

xs:string

The currency for this invoice. Use ISO 4217 currency codes.

 

start_date

Element [1]

xs:string

The start date for the billing period.

 

end_date

Element [1]

xs:string

The end date for the billing period.

 

description

Element [0,1]

xs:string

A description of the work performed for display to bill reviewers.

 

tax_point_date

Element [0,1]

xs:string

The financial period in which the tax applies (typically the same as the invoice date).

 

tax_invoice

Element [0,1]

xs:string

Indication whether or not this is a separate Tax Invoice.

 

credit_note

Element [0,1]

xs:string

Indication whether this is a Credit Note correcting a Tax Invoice.

 

credit_note_invoice_reference

Element [0,1]

xs:string

Invoice being referenced by a Credit Note.

 

payment_terms

Element [0,1]

xs:string

Indication of a conditional invoice reduction based on payment turnaround by the client.

 

vat_party

Element [0,1]

xs:string

Name of party paying VAT on the invoice.

 

other_iso

Element [0,1]

xs:string

Currency in which tax is presented for mixed currency billing.

 

regulatory_statement

Segment [0,1]

regulatoryStatementType

the regulatory detail associated with this invoice segment

 

address

Segment [0,1]

addressType

the address associated with this invoice segment

 

matters/matter

Segment [1]
Segment [1,*]

matterType

a collection of one or more matter segments for this invoice segment.

 

adjustments/adjustment

Segment [0,1]
Segment [0,*]

invoiceAdjustmentType

The adjustment segment of this matter segment. There can be zero or more adjustments.

 

item_taxes/item_tax

Segment [0,1]
Segment [0,*]

itemTaxType

The tax segment(s) of this invoice. These segments refer to the tax elements in the esf_doc segment

 

tax_summaries/tax_summary

Segment [0,1]
Segment [0,*]

taxSummaryType

The tax_summary segment for this invoice

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

regulatory_statement

 

regulatoryStatementType

In that this information is required by statute or regulation to be provided, all information provided in this segment should be captured by the receiving system and displayed during bill review.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema.

 

regulation_heading

Element [0,1]

xs:string

 

 

regulatory_statement

Element [0,1]

xs:string

 

 

matter

 

matterType

Detail segment identifying the matter/case information and associating it with the client and firm matter ids found in the charge detail segments.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the biller_org_matter_id is not unique.

 

payor_org_matter_id

Element [1]

xs:string

The payor organization assigned matter id or case reference number.

 

biller_org_matter_id

Element [1]

xs:string

The billing organization assigned matter id or case reference number.

 

name

Element [1]

xs:string

The descriptive name of the matter.

 

description

Element [0,1]

xs:string

Description of work performed this period.

 

po_number

Element [0,1]

xs:string

The alphanumeric, client-assigned purchase order number or code.

 

account_type

Element [0,1]

xs:string
Values: [ 'O', 'T' ]

An identifier indicating whether an invoice is "own account" ("O"), or "third party" ("T")

 

matter_type

Element [0,1]

xs:string
Values: [ 'CT', 'FF', 'GW', 'MPF', 'TM' ]

Code indicating how the matter is billed. Valid values and their descriptions are:
CT - Contingency Fee - When the law firm's fee is based on a percentage of the amount recovered by the law firm client in a plaintiff's action.
FF - Flat Fee - When the firm is paid a flat fee on the matter only.
GW - Goodwill Work - Where the firm has performed services for free for the client on a matter and provides information on the work performed in a separate $0 invoice to the client.
MPF - Multi-Payor Fees - When the cost of services provided on a matter is split by multiple clients of the firm regardless of any other matter_billing_type that may apply.
TM - Time & Materials - When the bill is based on hours worked, or where there may be a combination of hourly billing plus a flat fee by task arrangement.
A null value defaults to "TM"

 

matter_open_date

Element [1]

xs:string

This will come from 3E. It is a required field.

 

final_bill

Element [0,1]

xs:string

Indicator whether or not this is the final bill for this matter id.

 

currency

Element [0,1]

xs:string

Currency in which this matter is being billed.

 

total_fees

Element [0,1]

xs:decimal

Sum of fees on this matter. sum(fee.total_amount)

 

total_expenses

Element [0,1]

xs:decimal

Sum of expenses on this matter. sum(exp.total_amount)

 

total_fee_adjustment

Element [0,1]

xs:decimal

Sum of fee-related adjustments on this matter. sum(matter.adjustments type fee)

 

total_expense_adjustment

Element [0,1]

xs:decimal

Sum of expense-related adjustments on this matter. sum(matter.adjustments type exp)

 

percent_fees

Element [0,1]

xs:string

Percent of total billings on this invoice that are fees.

 

percent_expenses

Element [0,1]

xs:string

Percent of total billings on this invoice that are expenses.

 

fee_taxes

Element [0,1]

xs:decimal

Sum of taxes on fees on this matter.

 

expense_taxes

Element [0,1]

xs:decimal

Sum of taxes on expenses on this matter.

 

net_fees

Element [0,1]

xs:decimal

Net fees, accounting for pre- and post-split taxes.

 

net_expenses

Element [0,1]

xs:decimal

Net expenses, accounting for pre- and post-split taxes.

 

funds_applied

Element [0,1]

xs:decimal

Available funds that have already been applied to this matter.

 

total_due

Element [0,1]

xs:decimal

Total due to the payor organization for this matter on this invoice.

 

contact

Segment [0,1]

contactType

to be depricated

 

contacts/contact

Segment [0,1]
Segment [0,*]

typedContactType

The contacts segment for the matter

added support of multiple contact segments (contacts parent)

fees/fee

Segment [0,1]
Segment [0,*]

feeType

The fee segment for this matter. There can be zero or more fees.

 

expenses/expense

Segment [0,1]
Segment [0,*]

expenseType

The expense segment for this matter. There can be zero or more expenses

 

timekeepers/timekeeper

Segment [0,1]
Segment [0,*]

timekeeperType

The timekeeper segment for this matter. There can be zero or more timekeeper nodes

 

adjustments/adjustment

Segment [0,1]
Segment [0,*]

matterAdjustmentType

The adjustment segment for this matter. There can be zero or more adjustment nodes

 

tax_summaries/tax_summary

Segment [0,1]
Segment [0,*]

taxSummaryType

The tax_summary segment for this matter.

 

extended_fields

Segment

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

fee

 

feeType

Detail segment identifying individual 'fee' charges.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

xs:string

a unique ID for this fee element.

 

charge_date

Element [0,1]

xs:string

Date the service was performed.

 

timekeeper_id

Element [0,1]

xs:string

Unique id for the person performing the service billed by this line item.

 

timekeeper_level

Element [0,1]

xs:string

The level of the timekeeper.

added timekeeper level since same timekeeperId may have several rates and levels.

work_location_country

Element [0,1]

xs:string

Country where the work was performed (for tax purposes).

 

work_location_locality

Element [0,1]

xs:string

Location where the work was performed (for tax purposes).

 

charge_description

Element [0,1]

xs:string

Narrative description of the service provided for this line item.

 

task_code

Element [0,1]

xs:string

Task code for this line item.

 

activity_code

Element [0,1]

xs:string

Activity code for this line item.

 

charge_type

Element [0,1]

xs:string
Values: [ 'U', 'F' ]

"U" for unit-based pricing, "F" for fixed.

 

units

Element [0,1]

xs:decimal

Actual number of hours billed to this line item, in tenths.

 

rate

Element [0,1]

xs:decimal

The rate being charged for the person performing the service billed by this line item.

 

base_amount

Element [0,1]

xs:decimal

Original value of the work before adjustments.

 

units_work

Element [0,1]

xs:decimal

Use this field if the work values are different from the billed values. eBillingHub has a configuration where the difference can be shown as an inline adjustment.

 

rate_work

Element [0,1]

xs:decimal

Use this field if the work values are different from the billed values. eBillingHub has a configuration where the difference can be shown as an inline adjustment.

 

base_amount_work

Element [0,1]

xs:decimal

Use this field if the work values are different from the billed values. eBillingHub has a configuration where the difference can be shown as an inline adjustment.

 

item_tax_total

Element [0,1]

xs:decimal

Total tax on this line item.

 

item_adjustment_total

Element [0,1]

xs:decimal

Sum of adjustments on this line item.

 

total_amount

Element [0,1]

xs:decimal

Final billed value of the line item after application of all adjustments. (Taxes not included.)

 

adjustments/adjustment

Segment [0,1]
Segment [0,*]

feeAdjustmentType

The adjustment segment for this fee. There can be zero or more adjustment nodes

 

item_taxes/item_tax

Segment [0,1]
Segment [0,*]

itemTaxType

The tax segment(s) of this fee. These segments refer to the tax elements in the esf_doc segment

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

expense

 

expenseType

Detail segment identifying individual 'expense' charges.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

xs:string

a unique ID for this expense element.

 

charge_date

Element [0,1]

xs:string

Date the service was performed.

 

timekeeper_id

Element [0,1]

xs:string

Unique id for the person performing the service billed by this line item.

 

timekeeper_level

Element [0,1]

xs:string

The level of the timekeeper.

added timekeeper level since same timekeeperId may have several rates and levels.

work_location_country

Element [0,1]

xs:string

Country where the work was performed (for tax purposes).

 

work_location_locality

Element [0,1]

xs:string

Location where the work was performed (for tax purposes).

 

charge_description

Element [0,1]

xs:string

Narrative description of the service provided for this line item.

 

task_code

Element [0,1]

xs:string

Task code for this line item. (task code in expense?)

 

expense_code

Element [0,1]

xs:string

Expense code for this line item.

 

charge_type

Element [0,1]

xs:string
Values: [ 'U', 'F' ]

"U" for unit-based pricing, "F" for fixed.

 

units

Element [0,1]

xs:decimal

Actual number of hours billed to this line item, in tenths.

 

rate

Element [0,1]

xs:decimal

The rate being charged for the person performing the service billed by this line item

 

base_amount

Element [0,1]

xs:decimal

Original value of the work before adjustments.

 

item_tax_total

Element [0,1]

xs:decimal

Total tax on this line item.

 

item_adjustment_total

Element [0,1]

xs:decimal

Sum of adjustments on this line item.

 

total_amount

Element [0,1]

xs:decimal

Final billed value of the line item after application of all adjustments. (Taxes not included.)

 

adjustments/adjustment

Segment [0,1]
Segment [0,*]

expenseAdjustmentsType

The adjustment segment for this expnse. There can be zero or more adjustment nodes

 

item_taxes/item_tax

Segment [0,1]
Segment [0,*]

itemTaxesType

The tax segment(s) of this expense. These segments refer to the tax elements in the esf_doc segment

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

timekeeper

 

timekeeperType

Detail segment identifying timekepers related to charges against a matter.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

xs:string

Unique id of a person billing on this matter. The same id may appear multiple times if the timekeeper's name, level, or rate changes during the billing period.

 

first_name

Element [1]

xs:string

The first name of the timekeeper.

 

last_name

Element [1]

xs:string

The last name of the timekeeper.

 

tkinitials

Element [0,1]

xs:string

Use this value to populate the working timekeepers billing initials. eBillingHub has a configuration where it can show this on the LEDES output instead of the timekeeper number.

 

level

Element [1]

xs:string

The level of the timekeeper.

 

rate

Element [1]

xs:decimal

The hourly rate of the timekeeper.

 

extended_fields

Segment [0,1]

extendedFieldsType

Used for client and/or firm specific extensions. These are essentially (name,value) pairs of data where the name is an element and the value the data withon the element. There can be multiple extended field elements.

 

adjustment

 

feeAdjustmentType
expenseAdjustmentType
matterAdjustmentType
invoiceAdjustmentType

All discounts, credits and Alternate Fee Agreement items applied at the matter/invoice/fee/expense level.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema.

 

adjustment_type

Element [0,1]

For feeAdustmentType
xs:string
Values: [ 'FIA', 'FID', 'FIFF', 'FIDHR', 'Other' ]

For expenseAdjustmentType
xs:string
Values: [ 'EIA', 'EID', 'EIDHR', 'EIFF', 'Other' ]

For matterAdjustmentType
xs:string
Values: [ 'MIA', 'MIB', 'MICF', 'MICM', 'MIDB', 'MIDHR', 'MIFA', 'MIFF', 'MIR', 'MISF', 'Other' ]

For invoiceAdjustmentType
xs:string
Values: fee+exp+matter adjustemnt type values

The type of adjustment being applied to the line item or matter.

FIA - Fee item Adjustment - A flat adjustment (reduction or credit) applied to 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
FIDHR - Fee Item Discounted Hourly Rate - the discounted hourly rate applied to the fee item
EIA - Expense Item Adjustment - A flat adjustment (reduction or credit) applied to the fee item
EID - Expense Item Discount - client receives a percentage discount that is assessed at the expense item level
EIDHR - Expense Item Discounted Hourly Rate - the discounted hourly rate or unit rate applied to the expense item
EIFF - Expense Item is billed at a Flat Fee
MIA - Matter/Invoice Adjustment - A flat adjustment (reduction or credit) applied at the matter/invoice level.
MIB - Matter/Invoice Bonus - A bonus to be paid to the law firm on the matter/invoice.
MICF - Matter/Invoice Contingency Fee - The contingency fee to be paid to the law firm on the matter/invoice.  A contingency fee in this instance is when the law firm is paid based on a percentage of the amount awarded to the client, usually in representing a plaintiff.
MICM - Matter/Invoice Credit Memo - A credit memo, as requested by the client on the matter/invoice.  (In this case, it is the client who is processing the credit memo, not the law firm.  The credit memo represents a miscellaneous credit to the firm.) Note that a credit memo, as used here, is not the same thing as a Credit Note as used in @INVOICE.credit_note.
MIDB - Matter/Invoice Discounted Bill - Client receives a percentage discount assessed at the matter/invoice level.  Should have a maximum of one for fee items and one for expense items.
MIDHR  - Matter/Invoice Discounted Hourly Rate - A discounted hourly rate applied at the matter/invoice level.
MIFA - Matter/Invoice Funds Applied - Indicates the application of clients' funds or trust money to the total due on a matter/invoice.
MIFF - Matter/Invoice is billed at a Flat Fee.
MIR - Matter/Invoice Retainer - Used to bill a client for a retainer (an advance payment) to be paid to the law firm on the matter/invoice.  This could occur multiple times over the life of a matter.
MISF - Matter/Invoice Shared Fee - Fee is shared with another client and the client only pays a percentage of the bill, applied at the matter/invoice level.  Should have a maximum of one for fee items and one for expense items.
Other - Used to represent another type of AFA used by the client.

 

credit_note

Element [0,1]

xs:string

Required if adjustment_type is "Other" to specify arrangement.

 

adjustment_description

Element [0,1]

xs:string

Description/narrative of the adjustment

 

credit_type

Element [0,1]

xs:string
Values: [ 'Percent', 'Flat' ]

Type of credit being applied. Typically "Percent" or "Flat".
Note: only one of the fields should be populated: credit_type or discount_type

Note added

discount_type

Element [0,1]

xs:string
Values: [ 'Percent', 'Flat' ]

Type of discount being applied. Typically "Percent" or "Flat".
Note: only one of the fields should be populated: credit_type or discount_type

Note added

credit_category

Element [0,1]

xs:string
Values: [ 'Fees', 'Expenses', 'Matter' ]

Indicator whether the credit applies to fees, expenses, or the matter as a whole. Note: only one of the fields should be populated: credit_category or discount_category

Note added

discount_category

Element [0,1]

xs:string
Values: [ 'Fees', 'Expenses', 'Matter' ]

Indicator whether the discount applies to fees, expenses, or the matter as a whole. Note: only one of the fields should be populated: credit_category or discount_category

Note added

invoice_impact

Element [0,1]

xs:string
Values: [ 'Increase', 'Decrease' ]

Indicator whether the adjustment causes the invoice to increase or decrease.

 

split_impact

Element [0,1]

xs:string

Identifies whether the adjustment is applied before or after a split.

 

adjustment_amount

Element [0,1]

xs:decimal

Amount of the adjustment. Specified in decimal for "Percent" (0.10 for 10%") or dollar amount for "Flat" (-150.0000 or 150.0000, depending on direction).

 

item_tax_total

Element [0,1]

xs:decimal

Total tax on this line item.
Note: valid for matterAdjustmentType

new field added, for now optional for backward compatability

item_taxes/item_tax

Segment [0,1]
Segment [0,*]

itemTaxType

The tax segment(s) of this of this adjustment (Taxes specifc to the adjustment). These segments refer to the tax elements in the esf_doc segment.

 

tax

 

taxType

A lookup segment for the taxes charged in the file or matter.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the id is not unique.

 

id

Attribute [1]

xs:string

A unique identifier associated with the tax/rate/jurisdiction, assigned by the law firm.

 

tax_id_number

Element [0,1]

xs:string

Tax ID Number for law firm or vendor associated with specific tax.

 

name

Element [0,1]

xs:string

The name of the tax entity.

 

description

Element [0,1]

xs:string

Description of the tax entity.

 

type

Element [0,1]

xs:string

Type of tax, based on a value specified by the payor organization.

 

percent_rate

Element [0,1]

xs:decimal

Percentage tax rate, specified in decimal (i.e. 7.25% tax_rate_percent would be represented as "0.0725").

 

jurisdiction_country

Element [0,1]

xs:string

The country of the taxing jurisdiction. Use ISO 3166 country code.

 

jurisdiction_locality

Element [0,1]

xs:string

The location of the taxing jursidiction (State, County, City, Municipality, etc.)

 

tax_on_tax

Element [0,1]

xs:string

Indication that this is a "tax-on-tax" situation, where a second tax will be applied to the combination of the billable amount and a previous tax.

 

tax_on_tax_id

Element [0,1]

xs:string

The tax that is being included in the calculation for a "tax-on-tax" situation.

 

invoice_impact

Element [0,1]

xs:string
Values: [ 'Increase', 'Decrease' ]

Indicator whether the tax causes the invoice to increase or decrease.

 

tax_summary

 

taxSummaryType

The summary of taxes relevant to the parent matters.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the tax_id is not unique.

 

tax_id

Attribute [1]

xs:string

The unique identifier associated with a tax/rate/jurisdiction.

 

tax_id_number

Attribute [0,1]

xs:string

Mapped tax id for Vendor side and also used for complex tax grouping on Ebh side (optional: if mapping exists on time&billing side and or time&billing system supports complex taxes like 'tax-on-tax').

 

taxable_fees

Element [0,1]

xs:decimal

Total taxable amount of fees related to this tax identifier.

 

total_fee_taxes

Element [0,1]

xs:decimal

Total of tax due on the fees related to this tax identifier.

 

taxable_expenses

Element [0,1]

xs:decimal

Total taxable amount of expenses related to this tax identifier.

 

total_expense_taxes

Element [0,1]

xs:decimal

Total of tax due on the expenses related to this tax identifier.

 

item_tax

 

itemTaxType

The specific taxes relevant to the parent matters.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema. Only required when the tax_id is not unique.

 

tax_id

Attribute [1]

xs:string

The id for the tax segment associated with the tax on this item.

 

tax_id_number

Attribute [0,1]

xs:string

Mapped tax id for Vendor side and also used for complex tax grouping on Ebh side (optional: if mapping exists on time&billing side and or time&billing system supports complex taxes like 'tax-on-tax').

 

address
remit_address

 

addressType

Physical address for the parent organization issuing or receiving the bill.
Physical remit address for the parent organization issuing or receiving the bill.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema.

 

address_1

Element [1]

xs:string

The physical street address of parent.

 

address_2

Element [0,1]

xs:string

Optional second street address of parent.

 

address_3

Element [0,1]

xs:string

Optional third street address of parent.

 

city

Element [0,1]

xs:string

The city of parent.

 

state_province

Element [0,1]

xs:string

The state or province of parent. Required except in countries without an equivalent address component. Use accepted abbreviations mandated by the parent country's postal service.

 

zip_postal_code

Element [0,1]

xs:string

The postal code of parent. Required except in countries without an equivalent address component.

 

country

Element [0,1]

xs:string

The country of parent. Use ISO 3166 country code.

 

phone

Element [0,1]

xs:string

The phone number parent.

 

fax

Element [0,1]

xs:string

The fax number of parent.

 

contact

 

contactType
typedContactType

Detail for an individual contact at the parent organization.

 

node_id

Attribute [0,1]

xs:string

A unique id associated with this node, to allow for easy reference back to the element in the schema.

 

id

Attribute [1]

xs:string

Unique id for the contact.

 

type

Element [1]

contactTypeEnum
Values: [ 'lfManaging' , 'lf' , 'cl' ]

Required for multiple segments at matter level.
Note: valid for typedContactType

Added contact type to handle multiple contacts use case under matter segment

first_name

Element [0,1]

xs:string

The last name of the contact. 

 

last_name

Element [0,1]

xs:string

The first name of the contact. 

 

phone

Element [0,1]

xs:string

The phone number of the contact. 

 

fax

Element [0,1]

xs:string

The fax number of the contact. 

 

email

Element [0,1]

xs:string

The email address of the contact. 

 

extended_fields

 

extendedFieldsType

For the inclusion of additional information that may be required to complete the billing process.

 

node_id

Attribute [1]

xs:string

Name of the variable.

format: <{key}>{value}</{key}>

Element with any name

Element [0,*]

xs:string

Data to be used in the variable.

 

 

 

 

 

 

 

"Segment, Element, Attribute" legend:

 

 

 

 

Element [0,1]

It means that this item is optional (It occurs from 0 to 1 time.)

 

 

 

Element [0,*]

It means that this item is optional (It occurs from 0 to infinity times.)

 

 

 

Element [1]

It means that this item is required (It occurs 1 time.)

 

 

 

Element hierarchy

 

esfdoc

|------>

billing_org

|

|------>

address

|

|------>

remit_address

|

|------>

contact

|

|------>

extended_fields

|------>

payor_orgs/payor_org

|

|------>

invoice

|

|

|------>

regulatory_statement

|

|

|------>

address

|

|

|------>

matters/matter

|

|

|

|------>

contact

|

|

|

|------>

contacts/contact

|

|

|

|------>

fees/fee

|

|

|

|

|------>

adjustments/adjustment

|

|

|

|

|

|------>

item_taxes/item_tax

|

|

|

|

|------>

item_taxes/item_tax

|

|

|

|

|------>

extended_fields

|

|

|

|------>

expenses/expense

|

|

|

|

|------>

adjustments/adjustment

|

|

|

|

|

|------>

item_taxes/item_tax

|

|

|

|

|------>

item_taxes/item_tax

|

|

|

|

|------>

extended_fields

|

|

|

|------>

timekeepers/timekeeper

|

|

|

|

|------>

extended_fields

|

|

|

|------>

adjustments/adjustment

|

|

|

|

|------>

item_taxes/item_tax

|

|

|

|------>

tax_summaries/tax_summary

|

|

|

|------>

extended_fields

|

|

|------>

adjustments/adjustment

|

|

|

|------>

item_taxes/item_tax

|

|

|

|------>

item_tax_total

|

|

|------>

item_taxes/item_tax

|

|

|------>

tax_summaries/tax_summary

|

|

|------>

extended_fields

|

|------>

address

|

|------>

contact

|

|------>

extended_fields

|------>

taxes/tax

|------>

extended_fields