starkbank v2.6.2 StarkBank.TaxPayment.Log View Source
Groups TaxPayment related functions
Link to this section Summary
Functions
Every time a TaxPayment entity is modified, a corresponding TaxPayment Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the TaxPayment.
Receive a single TaxPayment Log struct previously created by the Stark Bank API by passing its id
Same as get(), but it will unwrap the error tuple and raise in case of errors.
Receive a list of up to 100 TaxPayment structs previously created in the Stark Bank API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.
Same as page(), but it will unwrap the error tuple and raise in case of errors.
Receive a stream of TaxPayment Log structs previously created in the Stark Bank API
Same as query(), but it will unwrap the error tuple and raise in case of errors.
Link to this section Types
Link to this section Functions
Every time a TaxPayment entity is modified, a corresponding TaxPayment Log is generated for the entity. This log is never generated by the user, but it can be retrieved to check additional information on the TaxPayment.
Attributes (return-only):
:id
[string]: unique id returned when payment is created. ex: "5656565656565656":payment
[TaxPayment]: TaxPayment entity to which the log refers to.:errors
[list of strings]: list of errors linked to this TaxPayment event.:type
[string]: tax type. ex: "das":created
[DateTime]: creation datetime for the payment. ex: "2020-03-10 10:30:00.000"
Receive a single TaxPayment Log struct previously created by the Stark Bank API by passing its id
Parameters (required):
:id
[string]: entity unique id. ex: "5656565656565656"
Options:
:user
[Organization/Project, default nil]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- TaxPayment Log struct with updated attributes
Same as get(), but it will unwrap the error tuple and raise in case of errors.
page(options \\ [])
View Sourcepage( cursor: binary(), limit: integer(), after: Date.t() | binary(), before: Date.t() | binary(), types: [binary()], payment_ids: [binary()], user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: {:ok, {binary(), [t()]}} | {:error, [%StarkBank.Error{code: term(), message: term()}]}
Receive a list of up to 100 TaxPayment structs previously created in the Stark Bank API and the cursor to the next page. Use this function instead of query if you want to manually page your requests.
Options:
:cursor
[string, default nil]: cursor returned on the previous page function call:limit
[integer, default nil]: maximum number of entities to be retrieved. Unlimited if nil. ex: 35:after
[Date or string, default nil]: date filter for entities created only after specified date. ex: ~D[2020-03-25]:before
[Date or string, default nil]: date filter for entities created only before specified date. ex: ~D[2020-03-25]:types
[list of strings, default null]: filter retrieved structs by event types. ex: 'paid' or 'registered':payment_ids
[list of strings, default null]: list of TaxPayment ids to filter retrieved structs. ex: ['5656565656565656', '4545454545454545']:user
[Organization/Project, default nil]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- list of TaxPayment structs with updated attributes and cursor to retrieve the next page of TaxPayment structs
Same as page(), but it will unwrap the error tuple and raise in case of errors.
query(options \\ [])
View Sourcequery( limit: integer(), after: Date.t() | binary(), before: Date.t() | binary(), types: [binary()], payment_ids: [binary()], user: StarkBank.User.Project.t() | StarkBank.User.Organization.t() ) :: ({:cont, {:ok, [t()]}} | {:error, [StarkBank.Error.t()]} | {:halt, any()} | {:suspend, any()}, any() -> any())
Receive a stream of TaxPayment Log structs previously created in the Stark Bank API
Options:
:limit
[integer, default nil]: maximum number of entities to be retrieved. Unlimited if nil. ex: 35:after
[Date or string, default nil]: date filter for entities created only after specified date. ex: ~D[2020-03-25]:before
[Date or string, default nil]: date filter for entities created only before specified date. ex: ~D[2020-03-25]:types
[list of strings, default null]: filter retrieved structs by event types. ex: 'paid' or 'registered':payment_ids
[list of strings, default null]: list of TaxPayment ids to filter retrieved structs. ex: ['5656565656565656', '4545454545454545']:user
[Organization/Project, default nil]: Organization or Project struct returned from StarkBank.project(). Only necessary if default project or organization has not been set in configs.
Return:
- stream of TaxPayment Log structs with updated attributes
Same as query(), but it will unwrap the error tuple and raise in case of errors.