baasic-sdk-angularjs/wiki/commerce/services/commerce-services-commerceInvoiceService.md

AngularJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).

# baasicCommerceInvoiceService

Baasic Commerce Invoice Service provides an easy way to consume Baasic Commerce REST API end-points. In order to obtain a needed routes `baasicCommerceInvoiceService` uses `baasicCommerceInvoiceRouteService`.



* * *

### baasicCommerceInvoiceService.find() 

Returns a promise that is resolved once the find action has been performed. Success response returns a list of commerce resources matching the given criteria.


**Example**:
```js
baasicCommerceInvoiceService.find({
  pageNumber : 1,
  pageSize : 10,
  orderBy : '<field>',
  orderDirection : '<asc|desc>',
  search : '<search-phrase>'
})
.success(function (collection) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});    
```


### baasicCommerceInvoiceService.get() 

Returns a promise that is resolved once the get action has been performed. Success response returns the commerce resource.


**Example**:
```js
baasicCommerceInvoiceService.get()
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceInvoiceService.update() 

Returns a promise that is resolved once the update commerce action has been performed; this action updates a commerce resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceInvoiceRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceInvoice);
var uri = params['model'].links('put').href;
```


**Example**:
```js
// commerceInvoice is a resource previously fetched using get action.
commerceInvoice.invoiceStatusId : '<new-invoice-status-id>';
baasicCommerceInvoiceService.update(commerceInvoice)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});
```


### baasicCommerceInvoiceService.remove() 

Returns a promise that is resolved once the remove action has been performed. This action will remove a commerce resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicCommerceInvoiceRouteService` route template. Here is an example of how a route can be obtained from HAL enabled objects:
```
var params = baasicApiService.removeParams(commerceInvoice);
var uri = params['model'].links('delete').href;
```


**Example**:
```js
// commerceInvoice is a resource previously fetched using get action.				 
baasicCommerceInvoiceService.remove(commerceInvoice)
.success(function (data) {
  // perform success action here
})
.error(function (response, status, headers, config) {
  // perform error handling here
});		
```


### baasicCommerceInvoiceService.streams.get() 

Returns a promise that is resolved once the get action has been performed. Success response returns the invoice stream if successfully completed.


**Example**:
```js
// commerceInvoice is a resource previously fetched using get action.	
baasicCommerceInvoiceService.stream.get({id: commerceInvoice.id})
.success(function (data) {
    // perform success action here
})
.error(function (response, status, headers, config) {
    // perform error handling here
});                    
```


### baasicCommerceInvoiceService.streams.getBlob() 

Returns a promise that is resolved once the get action has been performed. Success response returns the invoice stream as a blob. For more information on Blob objects please see [Blob Documentation](https://developer.mozilla.org/en-US/docs/Web/API/Blob).


**Example**:
```js
// Request the original blob                
baasicCommerceInvoiceService.stream.getBlobl({id: commerceInvoice.id})
.success(function (data) {
    // perform success action here
})
.error(function (response, status, headers, config) {
    // perform error handling here
});
```


### baasicCommerceInvoiceService.routeService() 

Provides direct access to `routeService`.


**Example**:
```js
baasicCommerceInvoiceService.routeService.get(expandObject);
```



* * *

**Notes:**
 - Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
 - All end-point objects are transformed by the associated route service.

*(c) 2017 Mono Ltd*

**Author:** Mono Ltd

**License:** MIT