Add more required types or explanation of limits to not adding fields #606
robindunkerley
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Issues
it is not clear to developers that the
lineItem
field must be included on the invoice object to avoid validationException errors.It is not clear that the
accountCode
field must be included on thelineItem
object in order to create invoices with a status ofInvoice.StatusEnum.AUTHORISED
without experiencing validationException errors.In order to send invoices using the
emailInvoice
method, invoices must have a status ofInvoice.StatusEnum.AUTHORISED
. This is not clear in and of itself, however, a solution to issue 2 would reduce unclear errors for developers.Suggested solutions
Make
lineItem
a required field on typeInvoice
.Make
accountCode
a required field on typelineItem
OR include an explanatory comment inlineItem.d.ts
highlighting its relation to adding a status of authorised.Beta Was this translation helpful? Give feedback.
All reactions