Invoices

Creates a new invoice associated with specified order.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

post

/v1/om/invoices

HTTPcURLJavaScriptPython

POST /v1/om/invoices HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "params": {
    "orderId": "text",
    "type": "credit-note",
    "referenceInvoiceId": "text",
    "applyExpiresAt": "text"
  }
}

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

Delates an invoice.

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

delete

/v1/om/invoices/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/om/invoices/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

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

Updates an invoice.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch

/v1/om/invoices/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/om/invoices/{uid} HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 93

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

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

Finalizes and closes an invoice.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

patch

/v1/om/invoices/{uid}/close

HTTPcURLJavaScriptPython

PATCH /v1/om/invoices/{uid}/close HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

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

Sends invoice via email to customer.

post

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

appstringRequired

servicestringRequired

warningsobject[]Required

instanceIdstringRequired

requestIdstringRequired

400

Functional Error

application/json

post

/v1/om/invoices/{uid}/send

HTTPcURLJavaScriptPython

POST /v1/om/invoices/{uid}/send HTTP/1.1
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

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