Skip to content
← Xero Developer Ideas

Settings and activity

1 result found

  1. Show TrackingOptionID in LineItem in Invoices API (and other endpoints)

    6 votes

    We're glad you're here

    Please sign in to leave feedback
    Signed in as (Sign out)
    Close
    Close

    We’ll send you updates on this idea

    7 comments  ·  Accounting API  ·  Admin →
    How important is this to you?

    We're glad you're here

    Please sign in to leave feedback
    Signed in as (Sign out)
    Close
    Close
    An error occurred while saving the comment
    IT Admin commented  · 

    For what it's worth, I checked the below (one more endpoint than I listed earlier) -

    bank transaction
    credit note line item
    invoice line item
    journal line
    manual journal line
    overpayment line item
    purchase order line item

    All return tracking for at least some line items. JournalLine does not (though ManualJournalLine does).

    I note for all those that do return tracking options, they are contained in a structure in the JSON labelled "Tracking", while for JournalLine, which fails to populate the structure - it's there but empty - the structure is named "TrackingCategories".

    This looks like it will solve 6/7ths of the issue.

    The API docs do not mention TrackingOptionID as being part of the results (yet?)

    Fingers crossed Xero checks why the JournalLine endpoint (Get Journal operation) is not populating the TrackingCategories structure.

    An error occurred while saving the comment
    IT Admin commented  · 

    @Chintan - whoa!

    I just tried the API Explorer for invoices, using Get Invoice to pull a single invoice, and can confirm, one tracking option ID is there!

    I then checked our raw warehouse table - which is created via the Fivetran connector ... and checked the Xero API documentation for that endpoint ... and no tracking option ID in either place.

    Perhaps Xero has literally only just rolled this out? Can I ask when did you first notice the option ID was in the endpoint?

    For my use case, I need the option ID in many other endpoints. I have not checked these in Explorer yet, but they are:

    credit note line item
    invoice line item
    journal line
    manual journal line
    overpayment line item
    purchase order line item

    An error occurred while saving the comment
    IT Admin commented  · 

    I posted a comment previously, but it's not showing. Xero support staff say they can see in the back-end that I posted, but don't know why it's not showing.

    In any case, I've added my vote. It's pretty frustrating that this issue was raised 29 months ago and Xero hasn't fixed it. I think this should be considered a bug, not a feature request. The API's tracking info does not provide any reliable key to link tracking back to financial transactions. The only field given is name, which can be changed in the UI. This means old transactions will be lost, and, if in future a prior tracking category option name gets re-used, transactions will be linked to the wrong category option. In short - the data coming through the API are unreliable (and the reports we are building are unreliable as a result).

    Having been a developer for 15+ years, this is surely a 15 minute fix for Xero developers. The field already exists. Just add a comma and the field name to each API that already includes tracking category info. Seriously, that's all. It shouldn't break anyone's existing usage of those APIs.

    IT Admin supported this idea  ·