freshbooks-php-sdk

AccountingResource extends BaseResource
in package

Table of Contents

Constants

DELETE  = 'DELETE'
GET  = 'GET'
PATCH  = 'PATCH'
POST  = 'POST'
PUT  = 'PUT'

Properties

$accountingPath  : string
$deleteViaUpdate  : bool
$httpClient  : HttpClient
$listModel  : string
$missingEndpoints  : array<string|int, mixed>|null
$singleModel  : string

Methods

__construct()  : mixed
create()  : DataTransferObject
Create a resource from either an array or a DataModel object.
delete()  : DataTransferObject
Delete a resource.
get()  : DataTransferObject
Get a single resource with the corresponding id.
list()  : DataTransferObject
Get a list of resources.
update()  : DataTransferObject
Update a resource from either an array or a DataModel object.
buildQueryString()  : string
getUrl()  : string
The the url to the accounting resource.
handleError()  : void
Create a FreshBooksException from the json response from the accounting endpoint.
makeRequest()  : array<string|int, mixed>
Make a request against the accounting resource and return an array of the json response.
rejectMissing()  : void

Constants

Properties

Methods

__construct()

public __construct(HttpClient $httpClient, string $accountingPath, string $singleModel, string $listModel[, bool $deleteViaUpdate = true ][, array<string|int, mixed> $missingEndpoints = null ]) : mixed
Parameters
$httpClient : HttpClient
$accountingPath : string
$singleModel : string
$listModel : string
$deleteViaUpdate : bool = true
$missingEndpoints : array<string|int, mixed> = null

create()

Create a resource from either an array or a DataModel object.

public create(string $accountId[, DataModel $model = null ][, array<string|int, mixed> $data = null ][, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
$accountId : string

The alpha-numeric account id

$model : DataModel = null

(Optional) The model to create

$data : array<string|int, mixed> = null

(Optional) The data to create the model with

$includes : IncludesBuilder|null = null
Return values
DataTransferObject —

Model of the new resource's response data.

delete()

Delete a resource.

public delete(string $accountId, int $resourceId) : DataTransferObject

Note: Most FreshBooks resources are soft-deleted, See FreshBooks API - Active and Deleted Objects

Parameters
$accountId : string

The alpha-numeric account id

$resourceId : int

Id of the resource to delete

Return values
DataTransferObject —

Null for some resources or the Model of the deleted resource's response data.

get()

Get a single resource with the corresponding id.

public get(string $accountId, int $resourceId[, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
$accountId : string

The alpha-numeric account id

$resourceId : int

Id of the resource to return

$includes : IncludesBuilder|null = null
Return values
DataTransferObject —

The result model

list()

Get a list of resources.

public list(string $accountId[, array<string|int, mixed> $builders = null ]) : DataTransferObject
Parameters
$accountId : string

The alpha-numeric account id

$builders : array<string|int, mixed> = null

(Optional) List of builder objects for filters, pagination, etc.

Return values
DataTransferObject —

The list result model

update()

Update a resource from either an array or a DataModel object.

public update(string $accountId, int $resourceId[, DataModel $model = null ][, array<string|int, mixed> $data = null ][, IncludesBuilder|null $includes = null ]) : DataTransferObject
Parameters
$accountId : string

The alpha-numeric account id

$resourceId : int

Id of the resource to update

$model : DataModel = null

(Optional) The model to update

$data : array<string|int, mixed> = null

(Optional) The data to update the model with

$includes : IncludesBuilder|null = null
Return values
DataTransferObject —

Model of the updated resource's response data.

buildQueryString()

protected buildQueryString(array<string|int, mixed>|null $builders) : string
Parameters
$builders : array<string|int, mixed>|null
Return values
string

getUrl()

The the url to the accounting resource.

protected getUrl(string $accountId[, int $resourceId = null ]) : string
Parameters
$accountId : string
$resourceId : int = null
Return values
string

handleError()

Create a FreshBooksException from the json response from the accounting endpoint.

protected handleError(int $statusCode, array<string|int, mixed> $responseData, string $rawRespone) : void
Parameters
$statusCode : int

HTTP status code

$responseData : array<string|int, mixed>

The json-parsed response

$rawRespone : string

The raw response body

makeRequest()

Make a request against the accounting resource and return an array of the json response.

protected makeRequest(string $method, string $url[, array<string|int, mixed> $data = null ]) : array<string|int, mixed>

Throws a FreshBooksException if the response is not a 200 or if the response cannot be parsed.

Parameters
$method : string
$url : string
$data : array<string|int, mixed> = null
Return values
array<string|int, mixed>

rejectMissing()

private rejectMissing(string $name) : void
Parameters
$name : string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results