Skip to content

Latest commit

 

History

History
99 lines (63 loc) · 2.19 KB

Invoice.md

File metadata and controls

99 lines (63 loc) · 2.19 KB

Invoice Controller

Method HTTP request
get GET /veem/v1.1/invoices/{invoice_id}
send POST /veem/v1.1/invoices
sendById POST /veem/v1.1/invoices/{invoice_id}/approve
draft POST /veem/v1.1/invoices
cancel POST /veem/v1.1/invoices/{invoice_id}/cancel

get

Retrieves a single invoice, based on specified a invoice ID.

Return

Returns a single Invoice model instance.

Usage

var sdk = new VeemSDK({ accessToken: <access_token> })

sdk.invoice.get(<invoice_id>)
  .then(responseBody => console.log(responseBody))
  .catch(error => console.error(error))

send

Creates and initiates a invoice.

Return

Returns the created Invoice model instance.

Usage

var sdk = new VeemSDK({ accessToken: <access_token> })

sdk.invoice.send(payload)
  .then(responseBody => console.log(responseBody))
  .catch(error => console.error(error))

sendById

Creates and initiates the invoice specified by the invoice ID.

Return

Returns the created Invoice model instance.

Usage

var sdk = new VeemSDK({ accessToken: <access_token> })

sdk.invoice.sendById(<invoice_id>)
  .then(responseBody => console.log(responseBody))
  .catch(error => console.error(error))

draft

Creates a draft invoice.

Return

Returns the draft Invoice model instance.

Usage

var sdk = new VeemSDK({ accessToken: <access_token> })

sdk.invoice.draft(payload)
  .then(responseBody => console.log(responseBody))
  .catch(error => console.error(error))

cancel

Cancels a invoice, based on specified invoice ID.

Return

Returns the cancelled Invoice model instance.

Usage

var sdk = new VeemSDK({ accessToken: <access_token> })

sdk.invoice.cancel(<invoice_id>)
  .then(responseBody => console.log(responseBody))
  .catch(error => console.error(error))