Update an Invoice by ID

put

https://platform.roserocket.com/api/v1/invoices/{invoiceID}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

invoiceID

string

required

ID of the invoice of the order. It could also be the external ID of the invoice, but in order to use external ID it has to follow this format: ext:{externalID} or external_id:{externalID}. So for example if the invoice's external ID is test123 then the value of invoiceID should be ext:test1234 or external_id:test1234.

Body Params

Invoice object

Document that lists goods/services that have been supplied and how much money is owed.

uuid

org_id

uuid

The uuid for the organization the invoice belongs to

order_id

uuid

Order id this quote is associated to

quote_id

uuid

Quote id this item is associated to

status

string

Order Status

currency

string

enum

Declared value currency

Allowed:

term

uuid

Pay term for Invoice

external_id

string

the external identifier for the invoice

qb_custom_id

string

The custom identifier for the invoice in QBO

qb_external_id

string

The external identifier for the invoice in QBO

xero_external_id

string

The external identifier for the invoice in Xero

qb_error_msg

string

Error message for QBO

xero_error_msg

string

Error message for Xero

revision

integer

The revision number of the invoice

invoice_date

date-time

Invoice creation date

due_date

date-time

Invoice due date

qb_exported_at

date-time

Date invoice was exported to QB

xero_exported_at

date-time

Date invoice was exported to Xero

sent_at

date-time

Date invoice was sent at

paid_at

date-time

Date invoice was paid at

to_email

string

The email of the recipient of the invoice

cc_email

string

The email of the cc recipient of the invoice

bill_to

object

notes

string

Notes on invoice

remit_to

object

sub_total_amount

integer

Subtotal Amount

tax_amount

integer

Tax amount

total_amount

integer

Total Amount

invoice_type

string

The type of invoice

consolidated_invoice_id

uuid

The Rose Rocket consolidated invoice ID

consolidated_invoice_full_id

string

The full id of the receivables invoice this invoice is a child of. This field value can be null

Responses

200successful operation

400Bad request