Credit Note Allocations (plus minor tweaks) #125
Conversation
add updated_at to accounts
add Statuses to invoice request params
get date and time for invoice and credit notes
add page option to credit note fetch
(since the complete hash had already been defined)
Adding Allocations to Credit Notes
|
Hi there! Thanks very much for the gem! Sorry about the large PR.... mostly I wanted to be able to allocate credit notes to invoices and see which invoices credit notes had been applied to when pulling down from Xero. Along the way I discovered a few little niggles which I also fixed. I thought some people might find them useful, and some were broken anyway (e.g. paging for credit notes) If you're ok with all this then great, but let me know if you'd rather I split it up into smaller PRs.... Best, Simon (aka sensadrome) |
When supplied with an invoice the “CreditNotes” are actually types of Allocation (Given that they have an applied amount)
For these items the object is not a tracking category but rather a selected option from a given trading category. Added TrackingOption
| @@ -791,7 +808,7 @@ def parse_response(raw_response, request = {}, options = {}) | |||
| end if response_element | |||
|
|
|||
| # If a single result is returned don't put it in an array | |||
| if response.response_item.is_a?(Array) && response.response_item.size == 1 | |||
| if response.response_item.is_a?(Array) && response.response_item.size == 1 && !parse_options[:dont_flatten] | |||
There was a problem hiding this comment.
This is a good solution for now, but we should really build up a list of the entities that are "flattenable" and those that just happen to be returning a single value :)
There was a problem hiding this comment.
This looks really good, thank you so much for the changes! I've left a couple notes, and I've given @armstrjare a 🔔 to check it out to since he's using TrackingCategories pretty heavily I think.
Thanks again!
| @@ -212,7 +213,7 @@ def self.from_xml(invoice_element, gateway = nil, options = {}) | |||
| when "Contact" then invoice.contact = Contact.from_xml(element) | |||
| when "Date" then invoice.date = parse_date(element.text) | |||
| when "DueDate" then invoice.due_date = parse_date(element.text) | |||
| when "UpdatedDateUTC" then invoice.updated_date_utc = parse_date(element.text) | |||
| when "UpdatedDateUTC" then invoice.updated_at = parse_date_time(element.text) | |||
There was a problem hiding this comment.
Changing this probably makes the PR a breaking change unfortunately. Do you think it would be worth maintaining the updated_date_utc API (i.e aliasing it?)
There was a problem hiding this comment.
well the reason for the change was simply that the attr_accessor is for updated_at and not updated_at_utc.
| # This means rather than going category.to_xml we need to call the special category.to_xml_for_invoice_messages | ||
| (tracking.is_a?(TrackingCategory) ? [tracking] : tracking).each do |category| | ||
| category.to_xml_for_invoice_messages(b) | ||
| b.Tracking do |
There was a problem hiding this comment.
@armstrjare want to check this one?
| end | ||
|
|
||
| def test_create_allocation | ||
| example_allocation = dummy_allocation.dup |
There was a problem hiding this comment.
I'm not 100% following why you're #dup-ing these sorry?
Added updated_at accessor to Account
Added :status filter for Invoice requests
Added :page option for paging credit notes
Added Allocation record (based on base_record) with tests
Fixed BaseRecord nested structure (so that to_xml works as expected)
Added
allocate_credit_noteaction to gateway which takes a credit note id, invoice_id and amount to allocate part of the credit note against an invoiceChanged the method for creating credit_notes to post as per Xero docs