Tipalti.API.Payer.get_payee_invoices_list_details

You're seeing just the function get_payee_invoices_list_details, go back to Tipalti.API.Payer module for more information.
Link to this function

get_payee_invoices_list_details(invoice_ref_codes)

View Source

Specs

get_payee_invoices_list_details([Tipalti.Invoice.ref_code()]) ::
  {:ok, [Tipalti.Invoice.t()]}
  | {:error, Tipalti.ClientError.t()}
  | {:error, Tipalti.RequestError.t()}

Return list of payee invoices.

Parameters

  • invoice_ref_codes: list of invoice reference codes

Examples

iex> get_payee_invoices_list_details(["12345","12346"])
{:ok,
[
  %Tipalti.Invoice{
    amount_due: Money.new!(:USD, "3.61"),
    approval_date: nil,
    approvers: [],
    can_approve: false,
    custom_fields: [],
    date: ~D[2018-07-23],
    description: "Some invoice",
    due_date: ~D[2018-07-27],
    idap: "payee1",
    internal_notes: "Notes",
    is_paid_manually: false,
    line_items: [
      %Tipalti.Invoice.Line{
        amount: Money.new!(:USD, "3.61"),
        custom_fields: [],
        description: "Charges",
        line_type: nil,
        quantity: nil
      }
    ],
    number: "h6gz1gs2e",
    payer_entity_name: "SomePayee",
    ref_code: "12345",
    status: :pending_payment
  },
  %Tipalti.Invoice{
    amount_due: Money.new!(:USD, "10.47"),
    approval_date: nil,
    approvers: [],
    can_approve: false,
    custom_fields: [],
    date: ~D[2018-07-18],
    description: "Some other invoice",
    due_date: ~D[2018-07-20],
    idap: "payee2",
    internal_notes: "Notes notes notes",
    is_paid_manually: false,
    line_items: [
      %Tipalti.Invoice.Line{
        amount: Money.new!(:USD, "10.47"),
        custom_fields: [],
        description: "Charges",
        line_type: nil,
        quantity: nil
      }
    ],
    number: "h6gz1grv4",
    payer_entity_name: "SomePayee",
    ref_code: "12346",
    status: :pending_payment
  }
]}