POST V3/odata/Invoice({key})/Send

Sends invoice

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key

InvoiceHeaderId from Invoice entity

integer

Required

Body Parameters

Parameters can be used to customize send process and are supplied in request body. Supported parameters are:

  • AllowToSendAlreadySentInvoice (Boolean) - indicates whether already sent invoice can be sent again (default: false).
  • SendInvoiceByEmailOverride (Boolean) - indicates whether invoice will be sent by email despite debtor send method (default: false).
  • InvoiceRecipientOverride (String) - email address where invoice will be sent overriding "Email address To" on invoice (default: empty). Mandatory when SendInvoiceByEmailOverride is true.

Example: {"AllowToSendAlreadySentInvoice":true, "SendInvoiceByEmailOverride": "true", "InvoiceRecipientOverride":"example@invoice.com"}

Request Formats

application/json, text/json, application/scim+json, application/xml, text/xml

Sample:

Sample not available.

Response Information

Resource Description

HTTP 202 (Accepted) with the async command id (long) in the response body when enqueue succeeds. AsyncCommandId - ID of job on Jobs page

System.Net.Http.HttpResponseMessage
NameDescriptionTypeAdditional information
Version

System.Version

None.

Content

System.Net.Http.HttpContent

None.

StatusCode

System.Net.HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

System.Net.Http.HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.