PayeeService Structure Reference


                    
                    
                    createPayee(planId:payee:)

Asynchronous

Creates a single payee.

Swift

public func createPayee(
    planId: String,
    payee: SavePayee
) async throws -> (Payee, ServerKnowledge)

`planId`	The id of the plan (last_used can also be used to specify the last used plan)
`payee`	The payee to create

A single payee and the last server knowledge


                    
                    
                    payees(planId:lastKnowledgeOfServer:)

Asynchronous

Returns all payees

Swift

public func payees(
    planId: String,
    lastKnowledgeOfServer: ServerKnowledge? = nil
) async throws -> ([Payee], ServerKnowledge)

`planId`	The id of the plan (last_used can also be used to specify the last used plan)
`lastKnowledgeOfServer`	If provided, only entities that have changed since `lastKnowledgeOfServer` will be included.

A list of payees and the last server knowledge


                    
                    
                    payee(planId:payeeId:)

Asynchronous

Returns a single payee.

Swift

public func payee(planId: String, payeeId: String) async throws -> Payee

`planId`	The id of the plan (last_used can also be used to specify the last used plan)
`lastKnowledgeOfServer`	If provided, only entities that have changed since `lastKnowledgeOfServer` will be included.

A single payee


                    
                    
                    updatePayee(planId:payeeId:payee:)

Asynchronous

Updates a single payee.

Swift

public func updatePayee(
    planId: String,
    payeeId: String,
    payee: SavePayee
) async throws -> (Payee, ServerKnowledge)

`planId`	The id of the plan (last_used can also be used to specify the last used plan)
`payeeId`	The id of the payee being update
`payee`	The details of the payee that need to be updated

A single payee and the last server knowledge