Points to Consider

Consider these key points when using the Invoices REST API:
  • Its capabilities and processing logic are similar to how the Payables application works in the Create and Edit Invoice pages.

For example, you can't update internal attributes, such as the WHO columns or Status columns.

  • You can update only certain attributes. Related fields don't automatically get populated. Cascade defaulting doesn't automatically happen, so you must review and update the dependent attributes.

For example, when you update the invoice date in the Create or Edit Invoice pages, related fields, such as the terms date or due date, may be auto populated based on the invoice date you enter. However, when using REST API, the invoice date is updated, but the related fields aren't auto populated. Before updating a key attribute, consider the impact on the related attributes.

  • Some resources, such as Invoice Lines and Invoice Installments and their child resources, have composite keys or hash keys.

For example, in the Invoice Lines resource, a hash key of InvoiceId and LineNumber identifies an invoice line. Currently, the REST endpoint documentation points to using LineNumber. Instead of using the LineNumber, query on the Invoice Lines collection resource with a filter on the primary key values to navigate to a specific instance of invoice lines. Refer to the Examples section in the Get an invoice line REST endpoint.