Codat.Accounting.Bills (codat v1.0.0)

Read and write supplier bills (accounts payable / purchase invoices).

Bills represent money owed by your company to a supplier.

Example

# List unpaid bills
{:ok, page} = Codat.Accounting.Bills.list(client, "company-id",
  query: "status=Open",
  order_by: "-dueDate"
)

# Create a bill
{:ok, push_op} = Codat.Accounting.Bills.create(client, company_id, conn_id, %{
  issueDate: "2024-01-01",
  dueDate: "2024-01-31",
  supplierRef: %{id: "supplier-id"},
  lineItems: [%{description: "Office supplies", quantity: 1, unitAmount: 500}]
})

Summary

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

Creates a new bills (async). Returns a push operation.

delete(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

Deletes a bills by ID (async).

fetch_all(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Fetches all bills across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

Fetches a single bills by ID.

get_attachments(client_or_company_id, company_or_bill_id, bill_or_opts \\ [])

Lists attachments for a bill.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

Returns the push model for creating bills.

get_update_model(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_id_or_opts \\ [])

Returns the push model for updating a bills record.

list(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Returns a paginated list of bills.

stream(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

Returns a lazy Stream of all results.

update(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_or_body, body_or_opts \\ %{})

Updates an existing bills (async).

Functions

create(client_or_company_id, company_or_conn_id, conn_or_body, body_or_opts \\ %{})

@spec create(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Creates a new bills (async). Returns a push operation.

delete(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

@spec delete(Codat.Client.t() | String.t(), String.t(), String.t() | keyword()) ::
  {:ok, nil} | {:error, Codat.Error.t()}

Deletes a bills by ID (async).

fetch_all(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec fetch_all(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  {:ok, [map()]} | {:error, Codat.Error.t()}

Fetches all bills across all pages concurrently.

get(client_or_company_id, company_or_resource_id, resource_id_or_opts \\ [])

@spec get(Codat.Client.t() | String.t(), String.t(), String.t() | keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Fetches a single bills by ID.

get_attachments(client_or_company_id, company_or_bill_id, bill_or_opts \\ [])

@spec get_attachments(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Lists attachments for a bill.

get_create_model(client_or_company_id, company_or_conn_id, opts \\ [])

@spec get_create_model(Codat.Client.t() | String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Returns the push model for creating bills.

get_update_model(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_id_or_opts \\ [])

@spec get_update_model(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | keyword(),
  keyword()
) ::
  {:ok, map()} | {:error, Codat.Error.t()}

Returns the push model for updating a bills record.

list(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec list(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  {:ok, Codat.Pagination.t()} | {:error, Codat.Error.t()}

Returns a paginated list of bills.

stream(client_or_company_id, company_id_or_opts \\ [], opts \\ [])

@spec stream(Codat.Client.t() | String.t(), String.t() | keyword(), keyword()) ::
  Enumerable.t()

Returns a lazy Stream of all results.

update(client_or_company_id, company_or_conn_id, conn_or_resource_id, resource_or_body, body_or_opts \\ %{})

@spec update(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) :: {:ok, map()} | {:error, Codat.Error.t()}

Updates an existing bills (async).