FortnoxEx.Models.Contract (FortnoxEx v0.1.0) View Source
Link to this section Summary
Functions
Creates a contract
Creates an invoice for a contract
Deletes a contract
Finishes a contract
Gets a contract
Increases the invoice count for a contract, without creating an invoice
Gets a list of partial contract objects with pagination information.
Streams a partial contract objects. Will go through each page of results with a delay between page. The stream will produce a single contract data object for each hit.
Updates a contract
Link to this section Functions
Creates a contract
Examples
iex> create_contract(client, %{"Name" => "ACME") {:ok, %{"DocumentNumber" => "1", "Name" => "ACME"}}
iex> create_contract(client, contract_attrs)
Creates an invoice for a contract
Examples
iex> create_invoice_for_contract(client, "1")
iex> create_invoice_for_contract(client, "missing")
Deletes a contract
Examples
iex> delete_contract(client, "1") :ok
iex> delete_contract(client, "missing")
Finishes a contract
Examples
iex> finish_contract(client, "1")
iex> finish_contract(client, "missing")
Gets a contract
Examples
iex> get_contract(client, "1")
iex> get_contract(clientm "1")
Increases the invoice count for a contract, without creating an invoice
Examples
iex> increase_invoice_count_for_contract(client, "1")
iex> increase_invoice_count_for_contract(client, "missing")
Gets a list of partial contract objects with pagination information.
Examples
iex> list_contracts(client, []) {:ok, %{"@CurrentPage" => 1, "@TotalPages" => 1, "@TotalResources" => 1}, [%{"DocumentNumber" => "1", "Name" => "ACME"}]}
iex> list_contracts(client, [])
Streams a partial contract objects. Will go through each page of results with a delay between page. The stream will produce a single contract data object for each hit.
Examples
iex> stream_contracts(client, []) stream_of_contracts
iex> stream_contracts(client, [])
Updates a contract
Examples
iex> update_contract(client, "1", %{"Name" => "Johnny"})
iex> update_contract(clientm "1", contract_attrs)