EmbedThis

Appearance

Invoice ​

Manage Invoices.

Download ​

Endpoint

POST /invoice/download

Authorized User Role

owner

Request Body

Field | Type | Required

  • | - | - id | string | yes

Response

A PDF binary string.

Get ​

Endpoint

POST /invoice/get

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - id | string | yes

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

Find ​

Endpoint

POST /invoice/find

Authorized User Role

admin

Request Body

A object.

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Paged response.

Field | Type | Notes

  • | - | - data | array | A list of cloud records. next | string | Paged cursor to use for the next page of items. prev | string | Pages cursor to use for the previous page of items.

Invoice

An array of Invoice items.

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

FindOutstanding ​

Endpoint

POST /invoice/findOutstanding

Authorized User Role

owner

Request Body

A object.

Query String Options

Field | Type

  • | - hidden | boolean filter | string limit | number next | object prev | object index | string where | string log | boolean

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

Init ​

Endpoint

POST /invoice/init

Authorized User Role

user

Request Body

A object.

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

Quote ​

Endpoint

POST /invoice/quote

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - bill | object | yes

Response

A PDF binary string.

Reissue ​

Endpoint

POST /invoice/reissue

Authorized User Role

admin

Request Body

Field | Type | Required

  • | - | - id | string | yes

Response

A PDF binary string.

UpdateMemo ​

Endpoint

POST /invoice/updateMemo

Authorized User Role

support

Request Body

Field | Type | Required

  • | - | - accountId | string | yes id | string | yes memo | string |

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

UpdateReminder ​

Endpoint

POST /invoice/updateReminder

Authorized User Role

support

Request Body

Field | Type | Required

  • | - | - accountId | string | yes id | string | yes nextReminder | date |

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number

UpdateReceived ​

Endpoint

POST /invoice/updateReceived

Authorized User Role

support

Request Body

Field | Type | Required

  • | - | - accountId | string | yes id | string | yes received | number |

Response

Field | Type

  • | - accountId | string amount | number date | date description | string due | date items | array id | string memo | string nextReminder | date number | string order | string paid | number pdf | string receipt | string submitted | date tax | number terms | number total | number