Invoices

Creates a new invoice associated with specified order.

post

Body

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /v1/om/invoices HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "params": {
    "orderId": "text",
    "type": 1,
    "referenceInvoiceId": "text",
    "applyExpiresAt": "text"
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "id": "text"
  }
}

Delates an invoice.

delete

Path parameters

idstringRequired

Responses

200Success

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/om/invoices/{id} HTTP/1.1
Host: 
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Updates an invoice.

patch

Path parameters

idstringRequired

Body

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/om/invoices/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 93

{
  "params": {
    "orderId": "text",
    "id": "text",
    "referenceInvoiceId": "text",
    "applyExpiresAt": "text"
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "success": true
  }
}

Finalizes and closes an invoice.

patch

Path parameters

idstringRequired

Responses

200Success

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/om/invoices/{id}/close HTTP/1.1
Host: 
Accept: */*

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "invoiceNumber": 1,
    "invoiceSource": "text",
    "invoicedAt": "text"
  }
}

Sends invoice via email to customer.

post

Path parameters

idstringRequired

Body

Responses

200Success

application/json

post

HTTPcURLJavaScriptPython

POST /v1/om/invoices/{id}/send HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "params": {
    "orderId": "text",
    "invoiceId": "text"
  }
}

200Success

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "success": true,
    "messageId": "text"
  }
}