Gormic.com

Invoices

Creates a new invoice associated with specified order.

post
Authorizations
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
200Success
application/json
post
POST /v1/om/invoices HTTP/1.1
Host: 
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
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
200Success
application/json
delete
DELETE /v1/om/invoices/{uid} HTTP/1.1
Host: 
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
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Body
Responses
200Success
application/json
patch
PATCH /v1/om/invoices/{uid} HTTP/1.1
Host: 
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
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
200Success
application/json
patch
PATCH /v1/om/invoices/{uid}/close HTTP/1.1
Host: 
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
Path parameters
uidstringRequired
Header parameters
organization-idstringRequired

Organization ID

Responses
200Success
application/json
post
POST /v1/om/invoices/{uid}/send HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

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

Was this helpful?