NAV
shell

Introduction

Hello! Blixo is an API for billing customers and getting paid.

Our API was designed to handle all of the billing needs for your business or application while making the integration process as painless as possible. Through the API we can help you seamlessly manage invoicing, payments, subscription billing, metered billing, estimates, pricing, and much more.

We designed the Blixo API around REST principles.

API Endpoint

All API calls must be made to https://api.blixo.com/v1/

JSON-only

All responses will be in JSON. Input data passed through the request body can be form-encoded or JSON-encoded. If using a JSON body, please specify the Content-Type header as application/json.

In the API dates are represented as UNIX timestamps. Each entity like customers or invoices has a unique integer ID.

PDFs

A few endpoints support returning a PDF response instead of JSON if you set the Accept header to application/pdf. For example, the retrieve invoice endpoint can return a PDF. The endpoints that support PDFs are notated in the documentation.

Getting Help

If you need help using the API or need to discuss anything sensitive please message us at [email protected].

Authentication

The API uses HTTP Basic Authentication to authenticate users. A valid API key is required for all requests.

Obtaining an API Key

An API key can be obtained by signing in to blixo.com, and then going to Settings → Developers → API Keys). Each business on Blixo has its own set of API keys. We recommend creating a separate API key for each application that will be making calls on your behalf.

Usage

curl "https://api.blixo.com/v1/customers" \
-u {API_KEY}:

The API key must be passed in through the username with the password left blank. The right sidebar has an example request with authorization

Errors

Each API call returns an HTTP status code that reflects the nature of the response. We have done our best to follow the HTTP status code conventions.

Any request that did not succeed will return a 4xx or 5xx error. The 4xx range means there was a problem with the request, like a missing parameter. The 5xx range means that something went wrong on our end.

The Blixo API uses the following error codes:

Error Code Meaning
400 Bad Request -- Your request is invalid.
401 Unauthorized -- Your API key is wrong.
403 Forbidden -- The kitten requested is hidden for administrators only.
404 Not Found -- The specified kitten could not be found.
405 Method Not Allowed -- You tried to access a kitten with an invalid method.
406 Not Acceptable -- You requested a format that isn't json.
410 Gone -- The kitten requested has been removed from our servers.
418 I'm a teapot.
429 Too Many Requests -- You're requesting too many kittens! Slow down!
500 Internal Server Error -- We had a problem with our server. Try again later.
503 Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

Pagination

Link: "<https://api.blixo.com/v1/customers?page=3&per_page=10>; rel="self",
      <https://api.blixo.com/v1/customers?page=1&per_page=10>; rel="first",
      <https://api.blixo.com/v1/customers?page=2&per_page=10>; rel="previous",
      <https://api.blixo.com/v1/customers?page=4&per_page=10>; rel="next",
      <https://api.blixo.com/v1/customers?page=5&per_page=10>; rel="last""

All list operations will be paginated in similar fashion as the GitHub API. In most cases we will paginate requests returning more than 100 results. You can control pagination with the page and per_page parameters. Pages start at 1 and the first page will be returned if no page is specified.

When traversing the pages, we recommend using the Link and X-Total-Count headers. The Link header will return URLs that you can use to traverse the API without having to write your own. It’s preferred to use the links from the API because it protects against future updates.

Customers

List all customers

This endpoint retrieves all customers.

curl "https://api.blixo.com/v1/customers" \
-u {API_KEY}:

The above command returns JSON structured like this:

[
  {
            "id": "6359246217320f015d7b90e9",
            "customerNo": "CUS-0408",
            "name": "Blixo Customer",
            "customerType": "COMPANY",
            "email": "[email protected]",
            "parentCustomerId": null,
            "billToParent": false,
            "language": "",
            "taxable": false,
            "taxIds": [],
            "creditHold": false,
            "contacts": [
                {
                    "billingContact": true,
                    "phone": "",
                    "address1": "",
                    "address2": "",
                    "city": "",
                    "state": "",
                    "zipCode": "",
                    "country": "",
                    "_id": "6359246217320f015d7b90ea",
                    "name": "Blixo Customer",
                    "email": "[email protected]",
                    "title": "",
                    "department": ""
                }
            ],
            "primaryContactId": null,
            "autopay": false,
            "autoConvertInvoice": true,
            "paymentSources": [],
            "paymentSourceRefs": [],
            "paymentDate": 0,
            "disabledPaymentMethods": [],
            "notes": "",
            "isChasingPaused": true,
            "chasingEnabled": false,
            "chasingId": null,
            "nextChasingStepId": null,
            "companyId": "622294998bec060152bcad9c",
            "enabled": true,
            "createdAt": "2022-10-26T12:13:22.878Z",
            "updatedAt": "2022-10-26T12:13:22.938Z",
            "source": "BLIXO",
            "chasing": null,
            "address": {
                "attn": "Blixo Customer",
                "phones": [],
                "address1": "",
                "address2": "",
                "city": "",
                "state": "Massachusetts",
                "zipCode": "01952",
                "country": "US"
            },
            "signInToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
  }
]

HTTP Request

GET /customers

Query Parameters

Parameter Type Description
sort string Column to sort by, i.e. name asc
page integer Current page
perPage integer Number of items per pages

Create a customer

curl "https://api.blixo.com/v1/customers" \
-u {API_KEY}: \
-d name="Blixo Customer" \
-d email="[email protected]" \
-d paymentTerms="NET_30" \
-d address[attn]="Sale Manager" \
-d address[address1]="2232 Stiles Street" \
-d address[city]="Bridgeville" \
-d address[state]="PA" \
-d address[zipCode]="15017" \
-d address[country]="US" \
-d address[phones][0]="412-603-3268" \
-d address[phones][1]="412-292-0048" \
-X POST

The above command returns JSON structured like this:

  {
    "id": "635a355811346c015d8bc155",
    "customerNo": "888234223",
    "name": "Blixo Customer",
    "customerType": "COMPANY",
    "email": "[email protected]",
    "parentCustomerId": null,
    "billToParent": false,
    "language": "",
    "taxable": false,
    "taxIds": [],
    "creditHold": false,
    "contacts": [],
    "primaryContactId": null,
    "autopay": false,
    "autoConvertInvoice": true,
    "paymentTerms": "DUE_ON_RECEIPT",
    "paymentSources": [],
    "paymentSourceRefs": [],
    "paymentDate": 0,
    "disabledPaymentMethods": [],
    "notes": "",
    "isChasingPaused": true,
    "chasingEnabled": true,
    "chasingId": null,
    "nextChasingStepId": null,
    "companyId": "622294998bec060152bcad9c",
    "enabled": true,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-27T07:38:00.319Z",
    "updatedAt": "2022-10-27T07:38:00.319Z",
    "source": "BLIXO",
    "address": {
        "attn": "Attention To",
        "phones": [
            ""
        ],
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "Address 2",
        "state": "",
        "zipCode": "",
        "country": "AO"
    }
}

Create a new customer profile with this endpoint.

HTTP Request

POST /customers

Query Parameters

Parameter Type Description
name string (required) Customer's name
email string Customer's email
customerNo string Customer's number. It will be generated automatically if not specified.
customerType string Organization type, Company or Individual. Defaults to Company.
paymentTerms string Customer's Payment Terms. It's one of the values DUE_ON_RECEIPT, CUSTOM, NET_7, NET_10, NET_15, NET_30, NET_60, NET_90
disabledPaymentMethods array List of payment methods to disable for this customer. Example: credit_card, ach, check, wire, cash, other
creditHold boolean When true, customer is on credit hold. Default: false
autopay boolean Auto pay. Default: false
autoConvertInvoice boolean Auto Convert Invoice. Default: true
billToParent boolean Bill To Parent. Default: false
chasingEnabled boolean Enable Chasing. Default: true
language string Two-letter ISO code
notes string Customer notes
paymentDate datetime Selected payment date
paymentSourceRefs array List of payment source refs
paymentSources array List of payment source
source string Source
signInToken string Sign-in token for customer portal
taxIds array List tax IDs
taxable boolean default: false
address object Address object includes address1, address2, attn, city, country, phones, state, zipCode

Update a customer

curl "https://api.blixo.com/v1/customers/:customerId" \
-u {API_KEY}: \
-d name="Blixo Customer" \
-d email="[email protected]" \
-d paymentTerms="NET_30" \
-d address[attn]="Sale Manager" \
-d address[address1]="2232 Stiles Street" \
-d address[city]="Bridgeville" \
-d address[state]="PA" \
-d address[zipCode]="15017" \
-d address[country]="US" \
-d address[phones][0]="412-603-3268" \
-d address[phones][1]="412-292-0048" \
-X PATCH

The above command returns JSON structured like this:

{
    "id": "635a355811346c015d8bc155",
    "customerNo": "888234223",
    "name": "Blixo Customer",
    "customerType": "COMPANY",
    "email": "[email protected]",
    "parentCustomerId": null,
    "billToParent": false,
    "language": "",
    "taxable": false,
    "taxIds": [],
    "creditHold": false,
    "contacts": [],
    "primaryContactId": null,
    "autopay": false,
    "autoConvertInvoice": true,
    "paymentTerms": "NET_15",
    "paymentSources": [],
    "paymentSourceRefs": [],
    "paymentDate": 0,
    "disabledPaymentMethods": [],
    "notes": "",
    "isChasingPaused": true,
    "chasingEnabled": true,
    "chasingId": null,
    "nextChasingStepId": null,
    "companyId": "622294998bec060152bcad9c",
    "enabled": true,
    "braintree": {
        "customerId": "289569268"
    },
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-27T07:38:00.319Z",
    "updatedAt": "2022-10-27T08:21:49.765Z",
    "source": "BLIXO",
    "address": {
        "attn": "Attention To",
        "phones": [
            "1212"
        ],
        "address1": "Address 1",
        "address2": "Address 2",
        "city": "Address 2",
        "state": "76543",
        "zipCode": "1",
        "country": "AO"
    }
}

Use this endpoint to update a customer profile.

HTTP Request

PATCH /customers/:customerId

Query Parameters

Parameter Type Description
name string (required) Customer's name
email string Customer's email
customerNo string Customer's number. It will be generated automatically if not specified.
customerType string Organization type, Company or Individual. Defaults to Company.
paymentTerms string Customer's Payment Terms. It's one of the values DUE_ON_RECEIPT, CUSTOM, NET_7, NET_10, NET_15, NET_30, NET_60, NET_90
disabledPaymentMethods array List of payment methods to disable for this customer. Example: credit_card, ach, check, wire, cash, other
creditHold boolean When true, customer is on credit hold. Default: false
autopay boolean Auto pay. Default: false
autoConvertInvoice boolean Auto Convert Invoice. Default: true
billToParent boolean Bill To Parent. Default: false
chasingEnabled boolean Enable Chasing. Default: true
language string Two-letter ISO code
notes string Customer notes
paymentDate datetime Selected payment date
paymentSourceRefs array List of payment source refs
paymentSources array List of payment source
source string Source
signInToken string Sign-in token for customer portal
taxIds array List tax IDs
taxable boolean default: false
address object Address object includes address1, address2, attn, city, country, phones, state, zipCode

Delete a customer

curl "https://api.blixo.com/v1/customers/:customerId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint deletes a specific customer.

HTTP Request

DELETE /customers/:customerId

Import customers

curl "https://api-staging.blixo.com/v1/imports/importCSV/customers" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "635aa8749e467f015e83bd97",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "customers",
    "name": "Customers from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-27T15:49:08.250Z",
    "updatedAt": "2022-10-27T15:49:08.250Z"
}

This endpoint import customers.

HTTP Request

POST /imports/importCSV/customers

Import contracts

curl "https://api-staging.blixo.com/v1/imports/importCSV/contacts" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "635aabad9e467f015e8470eb",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "contacts",
    "name": "Contacts from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-27T16:02:53.059Z",
    "updatedAt": "2022-10-27T16:02:53.059Z"
}

This endpoint import contracts.

HTTP Request

POST /imports/importCSV/contacts

Generate statement

curl "https://api-staging.blixo.com/v1/customers/statements/generate" \
-u {API_KEY}: 

The above command returns JSON structured like this:

{
  "type": "open_item",
  "currency": "usd",
  "date": "2022-10-28",
  "total_outstanding": true,
  "past_due":false
}

This endpoint returns a PDF of customer statement and total balance of items.

HTTP Request

GET /customers/:id/statements/generate

Query Parameters

Parameter Type Description
currency string 3-letter ISO code, defaults to customer currency
date string Statement Date, e.g. date[0]=2022-10-01&date[1]=2022-10-28
type string Statement type, balance_forward or open_item

Send a statement email

curl "https://api-staging.blixo.com/v1/customers/statements/send" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "to": "[email protected]",
    "bcc": "[email protected]e.com",
    "subject": "{{company_name}} Account Statement for {{customer_name}}",
    "message": "Hi customer, We have prepared an account statement for you. Your current account balance as of  {{statement_end_date}} is: {{statement_balance}}",
    "options": false,
    "type": "balance_forward",
    "currency": "USD",
    "startDate": "2022-10-01",
    "endDate": "2022-10-31"
}

This endpoint sends a PDF account statement to a customer by email.

HTTP Request

POST /customers/:id/statements/send

Query Parameters

Parameter Type Description
to string Optional comma-separated list of email addresses to be blind carbon copied
bcc string Email of customer will bcc
subject string Optional subject to override the template
message string Optional message body to override the template
currency string 3-letter ISO code, defaults to customer currency
startDate timestamp Used with balance forward statements
endDate timestamp Used with balance forward statements
type string Statement type, balance_forward or open_item

Download a customer

curl "https://api.blixo.com/v1/customers/:customerId/actions/download" \
-u {API_KEY}: \
-X GET \
-o customer.pdf

Download an customer with this endpoint.

HTTP Request

GET /customers/:customerId/actions/download

Invoices

List all invoices

curl "https://api.blixo.com/v1/invoices" \
-u {API_KEY}:

The above command returns JSON structured like this:

{
  "data": [
    {
      "id": "610c0d55aeafb90145d8cb5b",
      "invoiceNo": "INV-0003",
      "managerId": null,
      "issueDate": "2021-08-05T16:09:46.680Z",
      "dueDate": "2021-09-04T16:09:46.680Z",
      "billTo": {
        "attn": "Barbara",
        "phones": [
          "252-602-2731"
        ],
        "address1": "847 Rockwell Lane",
        "address2": "",
        "city": "Rocky Mount",
        "state": "North Carolina",
        "zipCode": "27801",
        "country": "US",
        "name": "Barbara J Thompson"
      },
      "notes": "",
      "attachments": [],
      "subTotalAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b3e",
        "value": 100,
        "unit": "$"
      },
      "totalAmount": {
        "currency": "USD",
        "value": 100,
        "unit": "$"
      },
      "balanceAmount": {
        "currency": "USD",
        "value": 100,
        "unit": "$"
      },
      "paymentStatus": [
        "OUTSTANDING"
      ],
      "paymentTerms": "NET_30",
      "invoiceStatus": [
        "DRAFT"
      ],
      "sentStatus": "NOT_SENT",
      "itemLines": [
        {
          "detail": null,
          "_id": "610c0d4a18d80318a12c11b6",
          "title": "test",
          "description": "",
          "quantity": 1,
          "rate": {
            "currency": "USD",
            "_id": "610c0d55aeafb90145d8cb5d",
            "value": 100,
            "unit": "$"
          },
          "amount": {
            "currency": "USD",
            "_id": "6110fdaa95c80501473b3b3a",
            "value": 100,
            "unit": "$"
          },
          "taxLines": [],
          "discountLines": [],
          "discountAmount": {
            "currency": "USD",
            "_id": "6110fdaa95c80501473b3b38",
            "value": 0,
            "unit": "$"
          },
          "discountedAmount": {
            "currency": "USD",
            "_id": "6110fdaa95c80501473b3b39",
            "value": 100,
            "unit": "$"
          }
        }
      ],
      "discountLines": [],
      "discountAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b3b",
        "value": 0,
        "unit": "$"
      },
      "discountedAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b3c",
        "value": 100,
        "unit": "$"
      },
      "taxLines": [],
      "taxAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b3d",
        "value": 0,
        "unit": "$"
      },
      "creditAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b40",
        "value": 0,
        "unit": "$"
      },
      "paidAmount": {
        "currency": "USD",
        "_id": "6110fdaa95c80501473b3b3f",
        "value": 0,
        "unit": "$"
      },
      "companyId": "60a7749e1f30710141d858cc",
      "customerId": "60a775021f30710141d85946",
      "createdBy": "60a7745d1f30710141d858c5",
      "updatedBy": "60a7745d1f30710141d858c5",
      "createdAt": "2021-08-05T16:09:57.617Z",
      "updatedAt": "2021-08-09T10:04:26.806Z",
      "expectedDate": "2022-10-28T04:17:09.000Z",
      "payments": [],
      "creditNotes": [],
      "chasingSchedules":[],
      "disableChasing": true
    }
  ],
  "pagination": {
    "total": 1
  }
}

This endpoint retrieves all invoices.

HTTP Request

GET /invoices

Query Parameters

Parameter Type Description
invoiceStatus array Filter by multiple invoice status, e.g.invoiceStatus[0]=DRAFT
paymentStatus array Filter by multiple payment status drafts, outstanding, pastdue, paid, all e.g. paymentStatus[0]=OUTSTANDING
sort array Sort by field name and its ordering, e.g. sort[0]=invoiceNo&sort[1]=-1
page integer Current page
perPage integer Number of items per pages

Create an invoice

curl "https://api.blixo.com/v1/invoices" \
-u {API_KEY}: \
-d paymentTerms="NET_30" \
-d paymentStatus[0]="OUTSTANDING" \
-d invoiceStatus[0]="ISSUED" \
-d issueDate="2021-08-22T17:05:58.112Z" \
-d dueDate="2021-09-21T17:05:58.112Z" \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="612283bafd4e6319d487fa8f" \
-d billTo[name]="Blixo Customer" \
-d billTo[attn]="Sale Manager" \
-d billTo[address1]="2232 Stiles Street" \
-d address[city]="Bridgeville" \
-d address[state]="PA" \
-d address[zipCode]="15017" \
-d address[country]="US" \
-d address[phones][0]="412-603-3268" \
-d address[phones][1]="412-292-0048" \
-d discountLines[0][name]="Discount 10%" \
-d discountLines[0][amount][unit]="%" \
-d discountLines[0][amount][value]=10 \
-d taxLines[0][name]="Tax 10%" \
-d taxLines[0][priceInclude]=false \
-d taxLines[0][amount][unit]="%" \
-d taxLines[0][amount][value]=10 \
-X POST

The above command returns JSON structured like this:

{
  "data": {
    "id": "611e9a42b946440146b166b2",
    "invoiceNo": "INV-0005",
    "managerId": null,
    "issueDate": "2021-08-19T17:51:37.402Z",
    "dueDate": "2021-09-18T17:51:37.402Z",
    "paidDate": null,
    "notes": "",
    "subTotalAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c4",
      "value": 100,
      "unit": "$"
    },
    "totalAmount": {
      "currency": "USD",
      "value": 100,
      "unit": "$"
    },
    "balanceAmount": {
      "currency": "USD",
      "value": 100,
      "unit": "$"
    },
    "paymentStatus": [
      "OUTSTANDING"
    ],
    "paymentTerms": "NET_30",
    "invoiceStatus": [
      "ISSUED"
    ],
    "sentStatus": "NOT_SENT",
    "discountLines": [],
    "discountAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c1",
      "value": 0,
      "unit": "$"
    },
    "discountedAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c2",
      "value": 100,
      "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c3",
      "value": 0,
      "unit": "$"
    },
    "creditAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c7",
      "value": 0,
      "unit": "$"
    },
    "paidAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c6",
      "value": 0,
      "unit": "$"
    },
    "companyId": "60a7749e1f30710141d858cc",
    "customerId": "60a775021f30710141d85946",
    "createdBy": "60a7745d1f30710141d858c5",
    "updatedBy": "60a7745d1f30710141d858c5",
    "createdAt": "2021-08-19T17:52:02.829Z",
    "updatedAt": "2021-08-19T17:52:04.234Z",
    "chasingSchedules": [],
    "installments": [],
    "invoiceEmail":"",
    "isPaymentPlan":false,
    "paymentDate": "2022-10-28T05:26:12.938Z",
    "paymentPlanAutoPay":false,
    "requireApprove":false,
    "shippingAmount":{
      "currency": "USD",
      "_id": "635b688b9e467f015ea06b2e",
      "value": 0,
      "unit": "$"
    },
    "shippingLines": [],
    "useCustomerEmail":true,
    "approvalDetail": null
  }
}

Create a new invoice with this endpoint.

HTTP Request

POST /invoices

Query Parameters

Parameter Type Description
customerId objectId Customer ID
companyId objectId Company ID
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
paymentTerms string Payment terms, e.g. CUSTOM, AUTO_PAY, DUE_ON_RECEIPT, NET_7, NET_10, NET_15, NET_30, NET_60, NET_90
paymentStatus array Payment status, e.g. OUTSTANDING, PASTDUE, PAID, PENDING, BABDEBT, VOIDED, BROKEN_PROMISE
invoiceStatus array Invoice status, e.g. ISSUED, DRAFT, CLOSED
invoiceNo string Invoice number
paymentate datetime Payment date
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, taxLines,integrations, amount, rate
taxLines array An array of tax items. Each item are an object includes amount, name, priceInclude
discountLines array An array of discount items. Each item are an object includes amount, name, _id
issueDate datetime Issue date
autopay boolean Auto pay. Default: true

Update an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId" \
-u {API_KEY}: \
-d notes="lorem ipsum" \
-d paymentTerms="NET_90" \
-d sentStatus="SENT" \
-X PATCH

The above command returns JSON structured like this:

{
  "data": {
    "id": "611e9a42b946440146b166b2",
    "invoiceNo": "INV-0005",
    "managerId": null,
    "issueDate": "2021-08-19T17:51:37.402Z",
    "dueDate": "2021-09-18T17:51:37.402Z",
    "paidDate": null,
    "notes": "",
    "subTotalAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c4",
      "value": 100,
      "unit": "$"
    },
    "totalAmount": {
      "currency": "USD",
      "value": 100,
      "unit": "$"
    },
    "balanceAmount": {
      "currency": "USD",
      "value": 100,
      "unit": "$"
    },
    "paymentStatus": [
      "OUTSTANDING"
    ],
    "paymentTerms": "NET_30",
    "invoiceStatus": [
      "ISSUED"
    ],
    "sentStatus": "NOT_SENT",
    "discountLines": [],
    "discountAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c1",
      "value": 0,
      "unit": "$"
    },
    "discountedAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c2",
      "value": 100,
      "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c3",
      "value": 0,
      "unit": "$"
    },
    "creditAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c7",
      "value": 0,
      "unit": "$"
    },
    "paidAmount": {
      "currency": "USD",
      "_id": "611e9a43b946440146b166c6",
      "value": 0,
      "unit": "$"
    },
    "companyId": "60a7749e1f30710141d858cc",
    "customerId": "60a775021f30710141d85946",
    "createdBy": "60a7745d1f30710141d858c5",
    "updatedBy": "60a7745d1f30710141d858c5",
    "createdAt": "2021-08-19T17:52:02.829Z",
    "updatedAt": "2021-08-19T17:52:04.234Z",
     "chasingSchedules": [],
     "useCustomerEmail":true,
  }
}

Update a new invoice with this endpoint.

HTTP Request

PATCH /invoices/:invoiceId

Query Parameters

Parameter Type Description
customerId objectId Customer ID
companyId objectId Company ID
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
paymentTerms string Payment terms, e.g. CUSTOM, AUTO_PAY, DUE_ON_RECEIPT, NET_7, NET_10, NET_15, NET_30, NET_60, NET_90
paymentStatus array Payment status, e.g. OUTSTANDING, PASTDUE, PAID, PENDING, BABDEBT, VOIDED, BROKEN_PROMISE
invoiceStatus array Invoice status, e.g. ISSUED, DRAFT, CLOSED
sentStatus string Invoice sent status, e.g. SENT or NOT_SENT
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, amount
taxLines array An array of tax items. Each item are an object includes amount, name, priceInclude
discountLines array An array of discount items. Each item are an object includes amount, name, _id
notes string Invoice notes
subTotalAmount object Sub total amount object includes currency, unit, value
totalAmount object Total amount object includes currency, unit, value
shippingAmount object Shipping amount object includes currency, unit, value
balanceAmount object Balance amount object includes currency, unit, value
paidAmount object Paid amount object includes _id, unit, value
discountAmount object Discount amount object
discountedAmount object Discounted amount object includes currency, unit, value
taxAmount object Tax amount object includes currency, unit, value
creditAmount object Credit amount object
issueDate datetime Issue date
dueDate datetime Due date
useCustomerEmail boolean Use ustome email. Default: true
source string Source

Delete an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint deletes a specific invoice.

HTTP Request

DELETE /invoices/:invoiceId

Close an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/close" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
  "data" : {
    "id": "635cce72a34c63015d3e01bc",
    "invoiceNo": "4355454",
    "managerId": null,
    "issueDate": "2022-10-29T06:54:59.491Z",
    "paymentDate": "2022-10-29T06:55:05.809Z",
    "paidDate": null,
    "billTo": {
        "attn": "Customer",
        "phones": [],
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "zipCode": "",
        "country": "DE",
        "integrations": {
            "shopify": {
                "addressId": "7571863634084"
            }
        },
        "name": "Customer"
    },
    "shipTo": {
        "name": "Customer",
        "attn": "Customer",
        "address1": "",
        "address2": "",
        "country": "DE",
        "city": "",
        "state": "",
        "zipCode": ""
    },
    "notes": "note",
    "attachments": [
        ""
    ],
    "subTotalAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01f6",
        "value": 34,
        "unit": "$"
    },
    "totalAmount": {
        "currency": "USD",
        "value": 34,
        "unit": "$"
    },
    "balanceAmount": {
        "currency": "USD",
        "value": 34,
        "unit": "$"
    },
    "paymentStatus": [
        "OUTSTANDING",
        "BADDEBT"
    ],
    "paymentTerms": "AUTO_PAY",
    "invoiceStatus": [
        "ISSUED",
        "CLOSED"
    ],
    "sentStatus": "NOT_SENT",
    "itemLines": [
        {
            "detail": {
                "description": "",
                "notTaxed": true,
                "notDiscounted": true,
                "productType": "PRODUCT"
            },
            "_id": "635cce5cd2ef2c5e752edacc",
            "title": "Custom Bundle Auto renew",
            "description": "",
            "quantity": 1,
            "rate": {
                "currency": "USD",
                "_id": "635cce72a34c63015d3e01be",
                "value": 34,
                "unit": "$"
            },
            "taxLines": [],
            "integrations": {
                "qbo": {
                    "qboId": "0",
                    "itemRefId": "0",
                    "qboSyncToken": "0"
                }
            },
            "amount": {
                "currency": "USD",
                "_id": "635cce72a34c63015d3e01e9",
                "value": 34,
                "unit": "$"
            },
            "discountLines": [],
            "discountAmount": {
                "currency": "USD",
                "_id": "635cce72a34c63015d3e01e7",
                "value": 0,
                "unit": "$"
            },
            "discountedAmount": {
                "currency": "USD",
                "_id": "635cce72a34c63015d3e01e8",
                "value": 34,
                "unit": "$"
            }
        }
    ],
    "discountLines": [],
    "discountAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01f3",
        "value": 0,
        "unit": "$"
    },
    "discountedAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01f4",
        "value": 34,
        "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01f5",
        "value": 0,
        "unit": "$"
    },
    "shippingLines": [],
    "shippingAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01f7",
        "value": 0,
        "unit": "$"
    },
    "creditAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01fb",
        "value": 0,
        "unit": "$"
    },
    "paidAmount": {
        "currency": "USD",
        "_id": "635cce72a34c63015d3e01fa",
        "value": 0,
        "unit": "$"
    },
    "companyId": "622294998bec060152bcad9c",
    "customerId": "6331629360eea3015e855e40",
    "disableChasing": true,
    "useCustomerEmail": true,
    "invoiceEmail": "",
    "chasingSchedules": [],
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-29T06:55:46.045Z",
    "updatedAt": "2022-10-30T01:41:16.689Z",
    "source": "BLIXO",
    "isPaymentPlan": false,
    "paymentPlanAutoPay": false,
    "requireApprove": false,
    "approvalDetail": null,
    "installments": [],
    "attemptCount": 0,
    "payments": [],
    "creditNotes": []
}
}

Close an invoice with this endpoint.

HTTP Request

POST /invoices/:invoiceId/actions/close

Reopen an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/reopen" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "635cce72a34c63015d3e01bc",
        "invoiceNo": "4355454",
        "managerId": null,
        "issueDate": "2022-10-29T06:54:59.491Z",
        "paymentDate": "2022-10-29T06:55:05.809Z",
        "paidDate": null,
        "billTo": {
            "attn": "Customer",
            "phones": [],
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "DE",
            "integrations": {
                "shopify": {
                    "addressId": "7571863634084"
                }
            },
            "name": "Customer"
        },
        "shipTo": {
            "name": "Customer",
            "attn": "Customer",
            "address1": "",
            "address2": "",
            "country": "DE",
            "city": "",
            "state": "",
            "zipCode": ""
        },
        "notes": "note",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f6",
            "value": 34,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 34,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": 34,
            "unit": "$"
        },
        "paymentStatus": [
            "OUTSTANDING"
        ],
        "paymentTerms": "AUTO_PAY",
        "invoiceStatus": [
            "ISSUED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [
            {
                "detail": {
                    "description": "",
                    "notTaxed": true,
                    "notDiscounted": true,
                    "productType": "PRODUCT"
                },
                "_id": "635cce5cd2ef2c5e752edacc",
                "title": "Custom Bundle Auto renew",
                "description": "",
                "quantity": 1,
                "rate": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01be",
                    "value": 34,
                    "unit": "$"
                },
                "taxLines": [],
                "integrations": {
                    "qbo": {
                        "qboId": "0",
                        "itemRefId": "0",
                        "qboSyncToken": "0"
                    }
                },
                "amount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e9",
                    "value": 34,
                    "unit": "$"
                },
                "discountLines": [],
                "discountAmount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e7",
                    "value": 0,
                    "unit": "$"
                },
                "discountedAmount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e8",
                    "value": 34,
                    "unit": "$"
                }
            }
        ],
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f3",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f4",
            "value": 34,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f5",
            "value": 0,
            "unit": "$"
        },
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f7",
            "value": 0,
            "unit": "$"
        },
        "creditAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01fb",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01fa",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "disableChasing": true,
        "useCustomerEmail": true,
        "invoiceEmail": "",
        "chasingSchedules": [],
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-10-29T06:55:46.045Z",
        "updatedAt": "2022-10-30T01:49:59.828Z",
        "source": "BLIXO",
        "isPaymentPlan": false,
        "paymentPlanAutoPay": false,
        "requireApprove": false,
        "approvalDetail": null,
        "installments": [],
        "attemptCount": 0,
        "creditNotes": [],
        "payments": []
    }
}

Reopen an invoice with this endpoint.

HTTP Request

POST /invoices/:invoiceId/actions/reopen

Mark an invoice as sent

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/marksent" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "630179145a32a40160513a84",
    "invoiceNo": "INV-0241",
    "managerId": null,
    "paidDate": null,
    "billTo": {
        "name": " ",
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "zipCode": "",
        "country": "",
        "phones": [
            ""
        ]
    },
    "shipTo": {
        "name": " ",
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "zipCode": "",
        "country": "",
        "phones": [
            ""
        ]
    },
    "notes": null,
    "attachments": [
        ""
    ],
    "subTotalAmount": {
        "currency": "EUR",
        "_id": "630179145a32a40160513aa7",
        "value": 56,
        "unit": "$"
    },
    "totalAmount": {
        "currency": "EUR",
        "value": 56,
        "unit": "$"
    },
    "balanceAmount": {
        "currency": "EUR",
        "value": 56,
        "unit": "$"
    },
    "paymentStatus": [
        "OUTSTANDING"
    ],
    "invoiceStatus": [
        "ISSUED"
    ],
    "sentStatus": "SENT",
    "itemLines": [
        {
            "detail": {
                "description": "Custom Bundle - 16 Meals. ",
                "notDiscounted": true,
                "notTaxed": false,
                "productType": "PRODUCT"
            },
            "_id": "630179145a32a40160513a85",
            "title": "Custom Bundle  - 16 Meals",
            "description": "Custom Bundle - 16 Meals.",
            "quantity": 1,
            "rate": {
                "currency": "EUR",
                "_id": "630179145a32a40160513a86",
                "value": 56,
                "unit": "$"
            },
            "amount": {
                "currency": "EUR",
                "_id": "630179145a32a40160513aa0",
                "value": 56,
                "unit": "$"
            },
            "taxLines": [],
            "discountLines": [],
            "integrations": {
                "shopify": {
                    "customerId": "6244557389988",
                    "orderId": "4728254726308",
                    "productId": "7101589749924",
                    "variantId": "41448600043684",
                    "variantTitle": "16 Meals",
                    "sku": "SUB-CUSTOM160",
                    "isOneTime": true
                }
            },
            "discountAmount": {
                "currency": "USD",
                "_id": "630179145a32a40160513a9e",
                "value": 0,
                "unit": "$"
            },
            "discountedAmount": {
                "currency": "EUR",
                "_id": "630179145a32a40160513a9f",
                "value": 56,
                "unit": "$"
            }
        }
    ],
    "discountLines": [],
    "discountAmount": {
        "currency": "EUR",
        "_id": "630179145a32a40160513aa4",
        "value": 0,
        "unit": "$"
    },
    "discountedAmount": {
        "currency": "EUR",
        "_id": "630179145a32a40160513aa5",
        "value": 56,
        "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
        "currency": "EUR",
        "_id": "630179145a32a40160513aa6",
        "value": 0,
        "unit": "$"
    },
    "shippingLines": [],
    "shippingAmount": {
        "currency": "USD",
        "_id": "630179145a32a40160513aa8",
        "value": 0,
        "unit": "$"
    },
    "creditAmount": {
        "currency": "USD",
        "_id": "630179145a32a40160513aac",
        "value": 0,
        "unit": "$"
    },
    "paidAmount": {
        "currency": "USD",
        "_id": "630179145a32a40160513aab",
        "value": 0,
        "unit": "$"
    },
    "companyId": "622294998bec060152bcad9c",
    "customerId": "62f135085ff37c016a57f0eb",
    "disableChasing": true,
    "useCustomerEmail": true,
    "invoiceEmail": "",
    "chasingSchedules": [],
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-08-21T00:15:16.522Z",
    "updatedAt": "2022-10-30T14:45:40.593Z",
    "source": "SHOPIFY",
    "integrations": {
        "shopify": {
            "orderId": "4728254726308",
            "customerId": "6244557389988",
            "orderUrl": "https://..",
            "lastSynced": 1661040916516
        },
        "bigquery": {}
    },
    "isPaymentPlan": false,
    "paymentPlanAutoPay": false,
    "requireApprove": false,
    "approvalDetail": null,
    "installments": [],
    "attemptCount": 0,
    "payments": [],
    "creditNotes": []
}

Mark an invoice as sent with this endpoint.

HTTP Request

POST /invoices/:invoiceId/actions/marksent

Download an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/download" \
-u {API_KEY}: \
-X GET \
-o invoice.pdf

Download an invoice with this endpoint.

HTTP Request

GET /invoices/:invoiceId/actions/download

Void an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/void" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "635cce72a34c63015d3e01bc",
        "invoiceNo": "4355454",
        "managerId": null,
        "issueDate": "2022-10-29T06:54:59.491Z",
        "paymentDate": "2022-10-29T06:55:05.809Z",
        "paidDate": null,
        "billTo": {
            "attn": "Customer",
            "phones": [],
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "DE",
            "integrations": {
                "shopify": {
                    "addressId": "7571863634084"
                }
            },
            "name": "Customer"
        },
        "shipTo": {
            "name": "Customer",
            "attn": "Customer",
            "address1": "",
            "address2": "",
            "country": "DE",
            "city": "",
            "state": "",
            "zipCode": ""
        },
        "notes": "note",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f6",
            "value": 34,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 34,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "paymentStatus": [
            "VOIDED"
        ],
        "paymentTerms": "AUTO_PAY",
        "invoiceStatus": [
            "ISSUED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [
            {
                "detail": {
                    "description": "",
                    "notTaxed": true,
                    "notDiscounted": true,
                    "productType": "PRODUCT"
                },
                "_id": "635cce5cd2ef2c5e752edacc",
                "title": "Custom Bundle Auto renew",
                "description": "",
                "quantity": 1,
                "rate": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01be",
                    "value": 34,
                    "unit": "$"
                },
                "taxLines": [],
                "integrations": {
                    "qbo": {
                        "qboId": "0",
                        "itemRefId": "0",
                        "qboSyncToken": "0"
                    }
                },
                "amount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e9",
                    "value": 34,
                    "unit": "$"
                },
                "discountLines": [],
                "discountAmount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e7",
                    "value": 0,
                    "unit": "$"
                },
                "discountedAmount": {
                    "currency": "USD",
                    "_id": "635cce72a34c63015d3e01e8",
                    "value": 34,
                    "unit": "$"
                }
            }
        ],
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f3",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f4",
            "value": 34,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f5",
            "value": 0,
            "unit": "$"
        },
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01f7",
            "value": 0,
            "unit": "$"
        },
        "creditAmount": {
            "currency": "USD",
            "_id": "635cce72a34c63015d3e01fb",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "currency": "USD",
            "_id": "635dd969a34c63015d1a2ba3",
            "value": 34,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "disableChasing": true,
        "useCustomerEmail": true,
        "invoiceEmail": "",
        "chasingSchedules": [],
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-10-29T06:55:46.045Z",
        "updatedAt": "2022-10-30T01:54:49.530Z",
        "source": "BLIXO",
        "isPaymentPlan": false,
        "paymentPlanAutoPay": false,
        "requireApprove": false,
        "approvalDetail": null,
        "installments": [],
        "attemptCount": 0,
        "payments": [],
        "creditNotes": []
    }
}

Void an invoice with this endpoint.

HTTP Request

POST /invoices/:invoiceId/actions/void

Remove an expected payment

curl "https://api.blixo.com/v1/invoices/:invoiceId/actions/removeExpectedPayment" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
  "data": {
    "id": "610d695a1fb214594f7a4e19",
    "invoiceNo": "INV-0036",
    "managerId": null,
    "issueDate": "2021-08-06T16:54:30.656Z",
    "dueDate": "2021-08-21T16:54:30.656Z",
    "expectedDate": null,
    "billTo": {
      "attn": "Antonio",
      "phones": [],
      "address1": "4157 Taylor Street 123",
      "address2": "",
      "city": "",
      "state": "",
      "zipCode": "",
      "country": "",
      "name": "Antonio L Krach"
    },
    "notes": "",
    "attachments": [
      ""
    ],
    "subTotalAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a7",
      "value": 30,
      "unit": "$"
    },
    "totalAmount": {
      "currency": "USD",
      "value": 27,
      "unit": "$"
    },
    "balanceAmount": {
      "currency": "USD",
      "value": 27,
      "unit": "$"
    },
    "paymentStatus": [
      "VOIDED"
    ],
    "paymentTerms": "NET_15",
    "invoiceStatus": [],
    "sentStatus": "SENT",
    "itemLines": [
      {
        "detail": {
          "description": "Lorem ipsum",
          "productType": "PRODUCT"
        },
        "_id": "610d69461a60a3f83544f758",
        "title": "test",
        "description": "",
        "quantity": 1,
        "rate": {
          "currency": "USD",
          "_id": "610d695a1fb214594f7a4e1b",
          "value": 30,
          "unit": "$"
        },
        "amount": {
          "currency": "USD",
          "_id": "61266fb50f86842a80b491a3",
          "value": 30,
          "unit": "$"
        },
        "discountLines": [
          {
            "_id": "610cd3ff6caa26134c947edf",
            "name": "Discount 10%",
            "amount": {
              "currency": "USD",
              "_id": "610cd3ff6caa26134c947ee0",
              "value": 10,
              "unit": "%"
            }
          }
        ],
        "taxLines": [],
        "discountAmount": {
          "currency": "USD",
          "_id": "61266fb50f86842a80b491a1",
          "value": 3,
          "unit": "$"
        },
        "discountedAmount": {
          "currency": "USD",
          "_id": "61266fb50f86842a80b491a2",
          "value": 27,
          "unit": "$"
        }
      }
    ],
    "discountLines": [],
    "discountAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a4",
      "value": 0,
      "unit": "$"
    },
    "discountedAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a5",
      "value": 27,
      "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a6",
      "value": 0,
      "unit": "$"
    },
    "creditAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a9",
      "value": 0,
      "unit": "$"
    },
    "paidAmount": {
      "currency": "USD",
      "_id": "61266fb50f86842a80b491a8",
      "value": 0,
      "unit": "$"
    },
    "companyId": "60e1b7f0c6ef4219ff51824c",
    "customerId": "61039770b733d94e98645c62",
    "createdBy": "60df577403bfb318db1bbac7",
    "updatedBy": "60df577403bfb318db1bbac7",
    "createdAt": "2021-08-06T16:54:50.549Z",
    "updatedAt": "2021-08-25T16:34:19.719Z",
    "payments": [],
    "creditNotes": []
  }
}

Remove an expected payment of an invoice with this endpoint.

HTTP Request

PATCH /invoices/:invoiceId/actions/removeExpectedPayment

Send an invoice

curl "https://api.blixo.com/v1/invoices/:invoiceId/send" \
-d to="[email protected]" \
-d bcc="[email protected]" \
-d subject="{{company_name}} Invoice {{invoice_number}} for {{customer_name}}" \
-d message="Hi {{customer_contact_name}},\n\nYour most recent {{company_name}} invoice is attached as Invoice {{invoice_number}}.pdf \nThe balance of {{balance}} is due by {{due_date}}.\n\nRemember that each payment method takes a few days to process so please remit payment at least one week before the due date to ensure it arrives on time.\n\nIf you have questions about your invoice, please contact us at {{company_email}} or reply to this email.\n\nWe appreciate your business and thank you for choosing {{company_name}}.\n\n{{view_invoice_button}}" \
-X POST

Send an invoice with this endpoint.

HTTP Request

POST /invoices/:invoiceId/send

Query Parameters

Parameter Type Description
to email (required) Receiver's email
bcc email Bcc email
subject string (required) Email subject
message string (required) Email message

Import invoices

curl "https://api-staging.blixo.com/v1/imports/importCSV/invoices" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "63636e41bc92e4015cc94c97",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "invoices",
    "name": "Invoices from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-11-03T07:31:13.609Z",
    "updatedAt": "2022-11-03T07:31:13.609Z"
}

This endpoint import invoices.

HTTP Request

POST /imports/importCSV/invoices

Credit Notes

List all credit notes

curl "https://api.blixo.com/v1/creditNotes" \
-u {API_KEY}:

This endpoint retrieves all creditNotes.

The above command returns JSON structured like this:

{
    "id": "630f97bcab6f32015e3a8b7f",
    "creditNoteNo": "CN-0024",
    "managerId": null,
    "issueDate": "2022-08-31T17:17:48.000Z",
    "paidDate": "2022-08-31T17:18:19.292Z",
    "billTo": {
        "name": " ",
        "address1": "",
        "address2": "",
        "city": "",
        "state": "",
        "zipCode": "",
        "country": "",
        "phones": [
            ""
        ]
    },
    "shipTo": {
        "name": "Natasha Test",
        "address1": "gg",
        "address2": null,
        "city": "gg",
        "state": "California",
        "zipCode": "90011",
        "country": "United States",
        "phones": [
            null
        ]
    },
    "notes": null,
    "attachments": [
        ""
    ],
    "subTotalAmount": {
        "_id": "630f97dbab6f32015e3a8cab",
        "value": 50,
        "unit": "$"
    },
    "totalAmount": {
        "value": 50,
        "unit": "$"
    },
    "balanceAmount": {
        "value": 0,
        "unit": "$"
    },
    "paymentStatus": [
        "PENDING",
        "PAID"
    ],
    "paymentTerms": "DUE_ON_RECEIPT",
    "creditNoteStatus": [
        "CLOSED"
    ],
    "sentStatus": "NOT_SENT",
    "itemLines": [
        {
            "_id": "630c99084c4c44015ebd8e44",
            "title": "Chai Latte ",
            "description": "Chai Latte ",
            "quantity": 16,
            "rate": {
                "_id": "630c99084c4c44015ebd8e45",
                "value": 0,
                "unit": "$"
            },
            "amount": {
                "_id": "630f97dbab6f32015e3a8ca8",
                "value": 0,
                "unit": "$"
            },
            "taxLines": [],
            "discountLines": [],
            "integrations": {
                "shopify": {
                    "customerId": "6270841913508",
                    "orderId": "4746555064484",
                    "productId": "7101592338596",
                    "variantId": "41448612069540",
                    "variantTitle": "",
                    "sku": "40-009",
                    "isOneTime": true
                }
            }
        }
    ],
    "discountLines": [],
    "discountAmount": {
        "_id": "630f97dbab6f32015e3a8caa",
        "value": 0,
        "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
        "_id": "630c99084c4c44015ebd8ee7",
        "value": 0,
        "unit": "$"
    },
    "paidAmount": {
        "_id": "630f97dbab6f32015e3a8caf",
        "value": 50,
        "unit": "$"
    },
    "companyId": "622294998bec060152bcad9c",
    "customerId": "630c90464c4c44015ebd7664",
    "invoiceId": "630c99084c4c44015ebd8e43",
    "shippingLines": [],
    "shippingAmount": {
        "_id": "630f97dbab6f32015e3a8cac",
        "value": 0,
        "unit": "$"
    },
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-08-31T17:17:48.989Z",
    "updatedAt": "2022-08-31T17:18:19.295Z",
    "integrations": {
        "shopify": {
            "orderId": "4746555064484",
            "customerId": "6270841913508",
            "orderUrl": "https://.....",
            "lastSynced": 1661769992085
        },
        "bigquery": {
            "lastOneTimeItemSynced": "2022-08-31T15:56:36.447Z"
        }
    },
    "payments": [],
    "transactions": [
        {
            "paymentMethod": "OTHER",
            "paymentType": "CREDIT_BALANCE",
            "paymentStatus": "SUCCEEDED",
            "source": "BLIXO",
            "_id": "630f97dbab6f32015e3a8c66",
            "amount": {
                "value": 50,
                "unit": "$",
                "currency": "USD"
            },
            "companyId": "622294998bec060152bcad9c",
            "customerId": "630c90464c4c44015ebd7664",
            "parentPayment": "630f97dbab6f32015e3a8c5d",
            "creditNoteId": "630f97bcab6f32015e3a8b7f",
            "invoiceId": "630c93f94c4c44015ebd7b93",
            "createdAt": "2022-08-31T17:18:19.213Z",
            "updatedAt": "2022-08-31T17:18:19.213Z",
            "__v": 0
        }
    ]
}

HTTP Request

GET /creditNotes

Query Parameters

Parameter Type Description
creditNoteStatus array Filter by multiple credit not status drafts, open, paid, all, e.g.creditNoteStatus[0]=DRAFT
paymentStatus array Filter by multiple payment status drafts, outstanding, pastdue, paid, all e.g. paymentStatus[0]=OUTSTANDING
sort array Sort by field name and its ordering, e.g. sort[0]=creditNoteNo&sort[1]=-1
page integer Current page
perPage integer Number of items per pages

Create a credit note

curl "https://api.blixo.com/v1/creditNotes" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="612283bafd4e6319d487fa8f" \
-d creditNoteNo="" \
-d creditNoteStatus[0]="OPEN" \
-d paymentStatus[0]="PENDING" \
-d sentStatus="NOT_SENT" \
-d issueDate="2021-08-22T17:18:17.182Z" \
-d itemLines[0][title]="item 1" \
-d itemLines[0][description]="" \
-d itemLines[0][isPlaceholder]=false \
-d itemLines[0][quantity]=1 \
-d itemLines[0][rate][unit]="$" \
-d itemLines[0][rate][value]=30 \
-d itemLines[0][amount][unit]="$" \
-d itemLines[0][amount][value]=30 \
-X POST

The above command returns JSON structured like this:

{
    "id": "635ea4dea34c63015dd9732c",
    "creditNoteNo": "CN-76541",
    "managerId": null,
    "issueDate": "2022-10-12T16:22:09.983Z",
    "paidDate": null,
    "notes": "45324634453536353941433339384332:c22951fea330493f49a72d85e01f037c",
    "subTotalAmount": {
        "_id": "635ea4dea34c63015dd97349",
        "value": 5589,
        "unit": "$"
    },
    "totalAmount": {
        "value": 5589,
        "unit": "$"
    },
    "balanceAmount": {
        "value": 5589,
        "unit": "$"
    },
    "paymentStatus": [
        "PENDING"
    ],
    "paymentTerms": "DUE_ON_RECEIPT",
    "creditNoteStatus": [
        "OPEN"
    ],
    "sentStatus": "NOT_SENT",
    "discountLines": [],
    "discountAmount": {
        "_id": "635ea4dea34c63015dd97347",
        "value": 0,
        "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
        "_id": "635ea4dea34c63015dd97348",
        "value": 0,
        "unit": "$"
    },
    "paidAmount": {
        "_id": "635ea4dea34c63015dd9734d",
        "value": 0,
        "unit": "$"
    },
    "companyId": "622294998bec060152bcad9c",
    "customerId": "6331629360eea3015e855e40",
    "shippingLines": [],
    "shippingAmount": {
        "_id": "635ea4dea34c63015dd9734a",
        "value": 0,
        "unit": "$"
    },
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-30T16:22:54.031Z",
    "updatedAt": "2022-10-30T16:22:54.069Z",
    "transactions": [],
    "payments": []
}

Create a new credit note with this endpoint.

HTTP Request

POST /creditNotes

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
creditNoteNo string Credit note number. It will be generated automatically if not specified.
creditNoteStatus array Credit note status, e.g. OPEN, DRAFT, CLOSED
paymentStatus array Payment status, e.g. OUTSTANDING, PASTDUE, PAID, PENDING, BABDEBT, VOIDED, BROKEN_PROMISE
sentStatus string Credit node sent status, e.g. SENT or NOT_SENT
notes string Notes
issueDate datetime Issue date
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, taxLines,integrations, amount, rate

Update a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="612283bafd4e6319d487fa8f" \
-d creditNoteNo="" \
-d creditNoteStatus[0]="OPEN" \
-d paymentStatus[0]="PENDING" \
-d sentStatus="NOT_SENT" \
-d issueDate="2021-08-22T17:18:17.182Z" \
-d itemLines[0][title]="item 1" \
-d itemLines[0][description]="" \
-d itemLines[0][isPlaceholder]=false \
-d itemLines[0][quantity]=1 \
-d itemLines[0][rate][unit]="$" \
-d itemLines[0][rate][value]=30 \
-d itemLines[0][amount][unit]="$" \
-d itemLines[0][amount][value]=30 \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
    "id": "635ea4dea34c63015dd9732c",
    "creditNoteNo": "CN-76541",
    "managerId": null,
    "issueDate": "2022-11-01T16:22:09.983Z",
    "paidDate": null,
    "notes": "45324634453536353941433339384332:9bc2996cba0ed6ef213480e305c88053",
    "subTotalAmount": {
        "_id": "635f7e3f966c9a015e03b478",
        "value": 34,
        "unit": "$"
    },
    "totalAmount": {
        "value": 29,
        "unit": "$"
    },
    "balanceAmount": {
        "value": 29,
        "unit": "$"
    },
    "paymentStatus": [
        "PENDING"
    ],
    "paymentTerms": "DUE_ON_RECEIPT",
    "creditNoteStatus": [
        "OPEN"
    ],
    "sentStatus": "NOT_SENT",
    "discountLines": [
        {
            "_id": "6307e9bffabacc015dd87bc3",
            "name": "Test  coupon 2",
            "amount": {
                "_id": "6307e9bffabacc015dd87bc4",
                "value": 5,
                "unit": "$"
            }
        }
    ],
    "discountAmount": {
        "_id": "635f7e3f966c9a015e03b477",
        "value": 5,
        "unit": "$"
    },
    "taxLines": [],
    "taxAmount": {
        "_id": "635ea4dea34c63015dd97348",
        "value": 0,
        "unit": "$"
    },
    "paidAmount": {
        "_id": "635f7e3f966c9a015e03b47c",
        "value": 0,
        "unit": "$"
    },
    "companyId": "622294998bec060152bcad9c",
    "customerId": "6331629360eea3015e855e40",
    "shippingLines": [],
    "shippingAmount": {
        "_id": "635f7e3f966c9a015e03b479",
        "value": 0,
        "unit": "$"
    },
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-30T16:22:54.031Z",
    "updatedAt": "2022-10-31T07:50:23.865Z"
}
}

Update a new credit note with this endpoint.

HTTP Request

PATCH /creditNotes/:creditNoteId

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
creditNoteNo string Credit note number. It will be generated automatically if not specified.
creditNoteStatus array Credit note status, e.g. OPEN, DRAFT, CLOSED
paymentStatus array Payment status, e.g. OUTSTANDING, PASTDUE, PAID, PENDING, BABDEBT, VOIDED, BROKEN_PROMISE
sentStatus string credit note sent status, e.g. SENT or NOT_SENT
paymentTerms string Customer's Payment Terms. It's one of the values DUE_ON_RECEIPT, CUSTOM, NET_7, NET_10, NET_15, NET_30, NET_60, NET_90
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, taxLines,integrations, amount, rate
discountLines array An array of discount items. Each item are an object includes amount, name, _id
discountAmount object Discount amount object includes _id, unit, value
taxLines array Tax line items
taxAmount object Tax amount object includes _id, unit, value
subTotalAmount object Sub total amount object includes _id, unit, value
totalAmount object Total amount object includes unit, value
balanceAmount object Balance amount object includes unit, value
paidAmount object Paid amount object includes _id, unit, value
attachments array An array of link attachment
paidDate datetime Paid date
notes string Notes
issueDate datetime Issue date
updatedAt datetime Updated date
updatedBy string Updated by id
createdBy string Created by id
createdAt datetime Created date

Delete a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint deletes a specific credit note.

HTTP Request

DELETE /creditNotes/:creditNoteId

Apply to invoice

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/applyInvoice" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "635f57f0a34c63015d23a980",
        "creditNoteNo": "CN-09876543456781",
        "managerId": null,
        "issueDate": "2022-11-09T05:06:23.001Z",
        "paidDate": "2022-10-31T09:06:31.253Z",
        "notes": "45324634453536353941433339384332:0a30a6b59f01a267e4cb2fdd9b6f7eb9",
        "subTotalAmount": {
            "_id": "635f9017966c9a015e09eec1",
            "value": 16,
            "unit": "$"
        },
        "totalAmount": {
            "value": 16,
            "unit": "$"
        },
        "balanceAmount": {
            "value": 0,
            "unit": "$"
        },
        "paymentStatus": [
            "PENDING",
            "PAID"
        ],
        "paymentTerms": "DUE_ON_RECEIPT",
        "creditNoteStatus": [
            "CLOSED"
        ],
        "sentStatus": "NOT_SENT",
        "discountLines": [],
        "discountAmount": {
            "_id": "635f9017966c9a015e09eec0",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "_id": "635f57f0a34c63015d23a99c",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "_id": "635f9017966c9a015e09eec5",
            "value": 16,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "shippingLines": [],
        "shippingAmount": {
            "_id": "635f9017966c9a015e09eec2",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-10-31T05:06:56.081Z",
        "updatedAt": "2022-10-31T09:06:31.255Z",
        "payments": []
    }
}

This endpoint apply to invoice credit note.

HTTP Request

POST /creditNotes/:creditNoteId/actions/applyInvoice

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
invoiceId string Invoice ID
creditNoteId string Credit Note ID
paymentMethod string Payment method
paymentType string Payment type
amount object Amount object includes unit, value, currency
note string Note

Issue credit

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/issue" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "635ea42fa34c63015dd79220",
        "creditNoteNo": "CN-5656565651",
        "managerId": null,
        "issueDate": "2022-10-05T16:17:31.022Z",
        "paidDate": "2022-10-31T08:40:41.061Z",
        "notes": "45324634453536353941433339384332:c22951fea330493f49a72d85e01f037c",
        "subTotalAmount": {
            "_id": "635f8a09966c9a015e07f9ff",
            "value": 6063030,
            "unit": "$"
        },
        "totalAmount": {
            "value": 6063030,
            "unit": "$"
        },
        "balanceAmount": {
            "value": 0,
            "unit": "$"
        },
        "paymentStatus": [
            "PENDING",
            "PAID"
        ],
        "paymentTerms": "DUE_ON_RECEIPT",
        "creditNoteStatus": [
            "CLOSED"
        ],
        "sentStatus": "NOT_SENT",
        "discountLines": [],
        "discountAmount": {
            "_id": "635f8a09966c9a015e07f9fe",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "_id": "635ea42fa34c63015dd79257",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "_id": "635f8a09966c9a015e07fa19",
            "value": 6063030,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "shippingLines": [],
        "shippingAmount": {
            "_id": "635f8a09966c9a015e07fa00",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-10-30T16:19:59.342Z",
        "updatedAt": "2022-10-31T08:40:41.063Z",
        "payments": []
    }
}

This endpoint issue credit a specific credit note.

HTTP Request

POST /creditNotes/:creditNoteId/actions/issue"

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
creditNoteId string Credit Note ID
paymentMethod string Payment method
paymentType string Payment type
amount object Amount object includes unit, value

Download a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/download" \
-u {API_KEY}: \
-X GET
-o creditnote.pdf

Download a credit note with this endpoint.

HTTP Request

GET /creditNotes/:creditNoteId/actions/download

Send a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/send" \
-d to="[email protected]" \
-d bcc="[email protected]" \
-d subject="{{company_name}} Credit Note {{credit_note_number}} for {{customer_name}}" \
-d message="Hi {{customer_contact_name}},
We prepared Credit Note #{{credit_note_number}} for you. We kindly ask that you review the credit note as soon as you can.
If you have questions about this credit note, please contact us at {{company_email}} or reply to this email.
We appreciate your business and thank you for choosing Blixo.
{{view_credit_note_button}}" \
-X POST

Send a credit note with this endpoint.

HTTP Request

POST /creditNotes/:creditNoteId/send

Query Parameters

Parameter Type Description
to email (required) Receiver's email
bcc email Bcc email
subject string (required) Email subject
message string (required) Email message

Reopen a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/reopen" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "632886b3861797016039ab18",
        "creditNoteNo": "CN-0027",
        "managerId": null,
        "issueDate": "2022-09-19T15:09:47.983Z",
        "dueDate": "2022-09-19T15:09:47.983Z",
        "paidDate": null,
        "billTo": {
            "name": "",
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "",
            "phones": []
        },
        "shipTo": "",
        "notes": "",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "_id": "632886b3861797016039ab44",
            "value": 45,
            "unit": "$"
        },
        "totalAmount": {
            "value": 45,
            "unit": "$"
        },
        "balanceAmount": {
            "value": 45,
            "unit": "$"
        },
        "paymentStatus": [
            "PENDING"
        ],
        "paymentTerms": "DUE_ON_RECEIPT",
        "creditNoteStatus": [
            "OPEN"
        ],
        "sentStatus": "SENT",
        "itemLines": [
            {
                "_id": "6328863c861797016039a939",
                "title": "16 Meals",
                "description": "",
                "quantity": 1,
                "rate": {
                    "_id": "6328863c861797016039a93a",
                    "unit": "$",
                    "value": 45
                },
                "taxLines": [],
                "discountLines": [],
                "amount": {
                    "_id": "632886b3861797016039ab42",
                    "value": 45,
                    "unit": "$"
                }
            }
        ],
        "discountLines": [],
        "discountAmount": {
            "_id": "632886b3861797016039ab43",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "_id": "6328863c861797016039a99a",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "_id": "632886b3861797016039ab48",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6327e430cbd87e015e2ccfe1",
        "invoiceId": "6328863c861797016039a938",
        "shippingLines": [],
        "shippingAmount": {
            "_id": "632886b3861797016039ab45",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-09-19T15:11:47.055Z",
        "updatedAt": "2022-10-31T14:26:19.895Z",
        "payments": []
    }
}

Reopen a credit note with this endpoint.

HTTP Request

POST /creditNotes/:creditNoteId/actions/reopen

Close a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/close" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "630f9cd0ab6f32015e3a8fde",
        "creditNoteNo": "CN-0025",
        "managerId": null,
        "issueDate": "2022-08-31T17:39:24.577Z",
        "paidDate": null,
        "billTo": {
            "attn": "Nguyen24 Nguyen24",
            "phones": [
                null
            ],
            "address1": "mb",
            "address2": null,
            "city": "mb",
            "state": "California",
            "zipCode": "90011",
            "country": "United States",
            "name": "Nguyen24 Nguyen24"
        },
        "notes": "",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff5",
            "value": 10,
            "unit": "$"
        },
        "totalAmount": {
            "value": 10,
            "unit": "$"
        },
        "balanceAmount": {
            "value": 10,
            "unit": "$"
        },
        "paymentStatus": [
            "PENDING"
        ],
        "paymentTerms": "DUE_ON_RECEIPT",
        "creditNoteStatus": [
            "OPEN",
            "CLOSED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [
            {
                "_id": "630f9c863ba3512a43cf6fd3",
                "title": "",
                "description": "",
                "quantity": 1,
                "rate": {
                    "_id": "630f9cd0ab6f32015e3a8fe0",
                    "unit": "$",
                    "value": 10
                },
                "amount": {
                    "_id": "630f9cd0ab6f32015e3a8ff2",
                    "value": 10,
                    "unit": "$"
                },
                "taxLines": [],
                "discountLines": []
            }
        ],
        "discountLines": [],
        "discountAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff3",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff4",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff9",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "630dde11c755b0015e9d7642",
        "shippingLines": [],
        "shippingAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff6",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-08-31T17:39:28.893Z",
        "updatedAt": "2022-10-31T15:12:23.766Z",
        "payments": []
    }
}

Close credit node with this endpoint.

HTTP Request

POST /creditNotes/:creditNoteId/actions/close

Void a credit note

curl "https://api.blixo.com/v1/creditNotes/:creditNoteId/actions/void" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "creditNoteNo": "CN-0025",
        "managerId": null,
        "notes": "",
        "attachments": [
            ""
        ],
        "paymentStatus": [
            "VOIDED"
        ],
        "paymentTerms": "DUE_ON_RECEIPT",
        "creditNoteStatus": [
            "OPEN",
            "CLOSED"
        ],
        "sentStatus": "NOT_SENT",
        "_id": "630f9cd0ab6f32015e3a8fde",
        "discountLines": [],
        "taxLines": [],
        "shippingLines": [],
        "issueDate": "2022-08-31T17:39:24.577Z",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "630dde11c755b0015e9d7642",
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-08-31T17:39:28.893Z",
        "updatedAt": "2022-10-31T15:20:18.252Z",
        "__enc_billTo_d": "",
        "__enc_billTo": false,
        "__enc_attachments_d": "",
        "__enc_attachments": false,
        "__enc_itemLines_d": "",
        "__enc_itemLines": false,
        "__v": 3,
        "balanceAmount": {
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff3",
            "value": 0,
            "unit": "$"
        },
        "paidAmount": {
            "_id": "635fe7b2966c9a015e325ce4",
            "value": 10,
            "unit": "$"
        },
        "paidDate": null,
        "shippingAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff6",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff5",
            "value": 10,
            "unit": "$"
        },
        "taxAmount": {
            "_id": "630f9cd0ab6f32015e3a8ff4",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "value": 10,
            "unit": "$"
        },
        "itemLines": [
            {
                "_id": "630f9c863ba3512a43cf6fd3",
                "title": "",
                "description": "",
                "quantity": 1,
                "rate": {
                    "_id": "630f9cd0ab6f32015e3a8fe0",
                    "unit": "$",
                    "value": 10
                },
                "amount": {
                    "_id": "630f9cd0ab6f32015e3a8ff2",
                    "value": 10,
                    "unit": "$"
                },
                "taxLines": [],
                "discountLines": []
            }
        ],
        "billTo": {
            "attn": "Nguyen24 Nguyen24",
            "phones": [
                null
            ],
            "address1": "mb",
            "address2": null,
            "city": "mb",
            "state": "California",
            "zipCode": "90011",
            "country": "United States",
            "name": "Nguyen24 Nguyen24"
        }
    }
}

This endpoint void a specific credit note.

HTTP Request

POST /creditNotes/:creditNoteId/actions/void

Import credit notes

curl "https://api-staging.blixo.com/v1/imports/importCSV/creditNotes" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "63636fc7bc92e4015cc94e8e",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "creditNotes",
    "name": "Creditnotes from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-11-03T07:37:43.530Z",
    "updatedAt": "2022-11-03T07:37:43.530Z"
}

This endpoint import credit notes.

HTTP Request

POST /imports/importCSV/creditNotes

Payments

List all payments

curl "https://api.blixo.com/v1/paymentsNew" \
-u {API_KEY}:

The above command returns JSON structured like this:

{
    "data": [
        {
            "id": "6361edc7673363015d37bc51",
            "paymentMethod": "OTHER",
            "paymentSourceRef": {
                "refId": ""
            },
            "paymentType": "CHARGE",
            "paymentStatus": "APPLIED",
            "appliedTo": [
                {
                    "_id": "6361edc7673363015d37bc52",
                    "type": "invoice",
                    "invoiceId": "6361edc7673363015d37bbe0",
                    "amount": {
                        "value": 32,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "note": "",
            "amount": {
                "value": 32,
                "unit": "$",
                "currency": "USD"
            },
            "companyId": "622294998bec060152bcad9c",
            "customerId": "62bfc64ed978bc016b84f870",
            "receiveDate": "2022-11-02T00:10:46.000Z",
            "isPaymentNew": true,
            "createdAt": "2022-11-02T04:10:47.958Z",
            "updatedAt": "2022-11-02T06:28:39.629Z",
            "source": "..",
            "integrations": {
                "shopify": {
                    "orderId": "4815745581220",
                    "customerId": "6153466577060",
                    "orderUrl": "",
                    "lastSynced": "2022-11-02T04:10:47+00:00"
                },
                "bigquery": {
                    "lastSynced": "2022-11-02T06:28:39.629Z"
                }
            },
            "transactions": [
                {
                    "paymentMethod": "OTHER",
                    "paymentType": "CHARGE",
                    "paymentStatus": "SUCCEEDED",
                    "source": "..",
                    "_id": "6361edc7673363015d37bc5b",
                    "amount": {
                        "value": 32,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "customerId": "62bfc64ed978bc016b84f870",
                    "receiveDate": "2022-11-02T00:10:46.000Z",
                    "parentPayment": "6361edc7673363015d37bc51",
                    "invoiceId": "6361edc7673363015d37bbe0",
                    "createdAt": "2022-11-02T04:10:47.986Z",
                    "updatedAt": "2022-11-02T04:10:47.986Z",
                    "__v": 0
                }
            ],
            "braintree": {},
            "stripe": {
                "paymentIntentId": "ch_3LzYHmEuHLA2PI560Bxd4pyg"
            }
        }
    ]
}

This endpoint retrieves all payments.

HTTP Request

GET /paymentsNew

Query Parameters

Parameter Type Description
companyId objectId (required) Company ID
isPaymentNew boolean Is new payment method. Default: true
sort array Sort by field name and its ordering, e.g. sort[0]=creditNoteNo&sort[1]=-1
page integer Current page
perPage integer Number of items per pages
paymentStatus array Payment status, e.g. NOT_APPLIED, APPLIED

Create a payment

curl "https://api.blixo.com/v1/paymentsNew" \
-u {API_KEY}: \

The above command returns JSON structured like this:

{
    "data": {
        "id": "63633c74bc92e4015cc7a9cc",
        "paymentMethod": "CASH",
        "paymentType": "PAYMENT",
        "paymentStatus": "APPLIED",
        "appliedTo": [
            {
                "_id": "63633c74bc92e4015cc7a9cd",
                "invoiceId": "635e9126a34c63015da3873a",
                "amount": {
                    "value": 76.85,
                    "unit": "$",
                    "currency": "USD"
                },
                "type": "invoice"
            },
            {
                "_id": "63633c74bc92e4015cc7a9ce",
                "type": "credit",
                "amount": {
                    "value": 23155.15,
                    "unit": "$",
                    "currency": "USD"
                }
            }
        ],
        "reference": "2345678",
        "note": "45324634453536353941433339384332:c22951fea330493f49a72d85e01f037c",
        "amount": {
            "value": 23232,
            "unit": "$",
            "currency": "USD"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "receiveDate": "2022-11-03T03:52:35.022Z",
        "isPaymentNew": true,
        "document": "INV-4226",
        "createdAt": "2022-11-03T03:58:44.450Z",
        "updatedAt": "2022-11-03T03:58:44.742Z",
        "source": "BLIXO",
        "transactions": [
            {
                "paymentMethod": "CASH",
                "paymentType": "PAYMENT",
                "paymentStatus": "SUCCEEDED",
                "source": "BLIXO",
                "_id": "63633c74bc92e4015cc7a9d7",
                "amount": {
                    "value": 76.85,
                    "unit": "$",
                    "currency": "USD"
                },
                "companyId": "622294998bec060152bcad9c",
                "customerId": "6331629360eea3015e855e40",
                "reference": "2345678",
                "receiveDate": "2022-11-03T03:52:35.022Z",
                "parentPayment": "63633c74bc92e4015cc7a9cc",
                "invoiceId": "635e9126a34c63015da3873a",
                "createdAt": "2022-11-03T03:58:44.564Z",
                "updatedAt": "2022-11-03T03:58:44.564Z"
            }
        ],
        "braintree": {},
        "stripe": {}
    }
}

Create a new payment with this endpoint.

HTTP Request

POST /paymentsNew

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
paymentMethod string Payment method
paymentType string Payment type
amount object Amount object includes unit, value, currency
creditAmount object Credit amount object includes unit, value, currency
appliedTo array An array of items. Each item are an object includes amount, type, invoiceId
reference string Reference ID number
note string Note

Update a payment

curl "https://api.blixo.com/v1/paymentsNew/:paymentId" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63634a39bc92e4015cc86bb0",
        "paymentMethod": "CASH",
        "paymentType": "PAYMENT",
        "paymentStatus": "APPLIED",
        "appliedTo": [
            {
                "_id": "63634a39bc92e4015cc86bb1",
                "invoiceId": "63041c165a32a4016051a5be",
                "amount": {
                    "value": 11,
                    "unit": "$",
                    "currency": "USD"
                },
                "type": "invoice"
            }
        ],
        "reference": "2345678",
        "note": "notes update payment",
        "amount": {
            "value": 11,
            "unit": "$",
            "currency": "USD"
        },
        "balance": {
            "value": 0,
            "unit": "$",
            "currency": "USD"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "receiveDate": "2022-11-03T04:49:43.384Z",
        "isPaymentNew": true,
        "document": "INV-0257",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-03T04:57:29.543Z",
        "updatedAt": "2022-11-03T06:34:42.532Z",
        "source": "BLIXO",
        "transactions": [
            {
                "paymentMethod": "CASH",
                "paymentType": "PAYMENT",
                "paymentStatus": "SUCCEEDED",
                "source": "BLIXO",
                "_id": "63634a39bc92e4015cc86bcb",
                "amount": {
                    "value": 11,
                    "unit": "$",
                    "currency": "USD"
                },
                "companyId": "622294998bec060152bcad9c",
                "customerId": "62f135085ff37c016a57f0eb",
                "reference": "2345678",
                "receiveDate": "2022-11-03T04:49:43.384Z",
                "parentPayment": "63634a39bc92e4015cc86bb0",
                "invoiceId": "63041c165a32a4016051a5be",
                "createdAt": "2022-11-03T04:57:29.569Z",
                "updatedAt": "2022-11-03T04:57:29.569Z",
                "__v": 0
            }
        ],
        "braintree": {},
        "stripe": {}
    }
}

Update a payment with this endpoint.

HTTP Request

PATCH /paymentsNew/:paymentId

Query Parameters

Parameter Type Description
companyId string Company ID
customerId string Customer ID
paymentMethod string Payment method
paymentType string Payment type
amount object Amount object includes unit, value, currency
creditAmount object Credit amount object includes unit, value, currency
reference string Reference ID number
note string Note

Delete a payment

curl "https://api.blixo.com/v1/payments/:paymentId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint deletes a specific payment.

HTTP Request

DELETE /payments/:paymentId

Download a payment

curl "https://api.blixo.com/v1/payments/:paymentId/actions/download" \
-u {API_KEY}: \
-X GET \
-o payment.pdf

Download an payment with this endpoint.

HTTP Request

GET /payments/:paymentId/actions/download

Send a payment receipt

curl "https://api.blixo.com/v1/paymentsNew/:paymentId/actions/sendReceipt" \
-d to="[email protected]" \
-d bcc="[email protected]" \
-d subject="Thank You – Receipt for {{company_name}} Invoice {{invoice_number}} for {{customer_name}}" \
-d message="Hi {{customer_contact_name}},
We are writing to inform you that {{company_name}} Invoice {{invoice_number}} has been paid in full. Please keep the attached PDF for your records.
We appreciate your business and thank you for choosing Blixo." \
-X POST

Send a payment receipt with this endpoint.

HTTP Request

POST /paymentsNew/:paymentId/actions/sendReceipt

Query Parameters

Parameter Type Description
to email (required) Receiver's email
bcc email Bcc email
subject string (required) Email subject
message string (required) Email message

Void a payment

curl "https://api.blixo.com/v1/paymentsNew/:paymentId/actions/void" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63635be3bc92e4015cc92e45",
        "paymentMethod": "SCHEME",
        "paymentType": "CHARGE",
        "paymentStatus": "VOIDED",
        "appliedTo": [],
        "note": "",
        "amount": {
            "value": 0,
            "unit": "$",
            "currency": "USD"
        },
        "balance": {
            "value": 0,
            "unit": "$",
            "currency": "USD"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "receiveDate": "2022-11-03T06:12:22.769Z",
        "isPaymentNew": true,
        "document": "INV-0257",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-03T06:12:51.284Z",
        "updatedAt": "2022-11-03T06:56:16.763Z",
        "source": "BLIXO",
        "transactions": [],
        "braintree": {
            "transactionId": "59ngy78x"
        },
        "stripe": {}
    }
}

This endpoint void a specific payment.

HTTP Request

POST /paymentsNew/:paymentId/actions/void

Refund a payment

curl "https://api.blixo.com/v1/paymentsNew/:paymentId/actions/refund" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63634712bc92e4015cc8637b",
        "paymentMethod": "SCHEME",
        "paymentType": "CHARGE",
        "paymentStatus": "APPLIED",
        "appliedTo": [
            {
                "_id": "63634712bc92e4015cc8637c",
                "invoiceId": "635e9536a34c63015dae40c3",
                "amount": {
                    "value": 33,
                    "unit": "$",
                    "currency": "USD"
                },
                "type": "invoice"
            }
        ],
        "reference": "nbhgdzmd",
        "note": "...",
        "amount": {
            "value": 33,
            "unit": "$",
            "currency": "USD"
        },
        "refundAmount": {
            "value": 33,
            "unit": "$",
            "currency": "USD"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "receiveDate": "2022-11-03T04:43:37.215Z",
        "isPaymentNew": true,
        "document": "INV-4227",
        "createdAt": "2022-11-03T04:44:02.052Z",
        "updatedAt": "2022-11-03T07:25:32.214Z",
        "source": "BLIXO",
        "transactions": [
            {
                "paymentMethod": "SCHEME",
                "paymentType": "CHARGE",
                "paymentStatus": "SUCCEEDED",
                "source": "BLIXO",
                "_id": "63634712bc92e4015cc86396",
                "amount": {
                    "value": 33,
                    "unit": "$",
                    "currency": "USD"
                },
                "companyId": "622294998bec060152bcad9c",
                "customerId": "62f135085ff37c016a57f0eb",
                "receiveDate": "2022-11-03T04:43:37.215Z",
                "parentPayment": "63634712bc92e4015cc8637b",
                "invoiceId": "635e9536a34c63015dae40c3",
                "createdAt": "2022-11-03T04:44:02.081Z",
                "updatedAt": "2022-11-03T04:44:02.081Z"
            }
        ],
        "braintree": {
            "transactionId": "n8sgpy4g"
        },
        "stripe": {}
    }
}

This endpoint refund a specific payment.

HTTP Request

POST /paymentsNew/:paymentId/actions/refund

Query Parameters

Parameter Type Description
amount object (required) An amount object includes currency, unit, value

Import payments

curl "https://api-staging.blixo.com/v1/imports/importCSV/payments" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "63636fc7bc92e4015cc94e8e",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "payments",
    "name": "payments from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-11-03T07:37:43.530Z",
    "updatedAt": "2022-11-03T07:37:43.530Z"
}

This endpoint import payments.

HTTP Request

POST /imports/importCSV/payments

Subscriptions

List all subscriptions

curl "https://api.blixo.com/v1/subscriptions" \
-u {API_KEY}:

This endpoint retrieves all subscriptions.

The above command returns JSON structured like this:

{
  "data": [
    {
        "id": "635b861c1a5711015ef679f0",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "634d16dcc9d031e8c4f41674",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": -2222,
        "contractRenewal": "AUTO_RENEW",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": -2222,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "635b861c1a5711015ef67a30"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-10-28T07:34:52.325Z",
                    "toDate": "2022-11-28T07:34:52.325Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6365108175012",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-28T07:34:52.325Z",
                    "toDate": "2022-12-28T07:34:52+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6365108175012",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "startDate": "2022-10-28T07:34:52.325Z",
        "endDate": "1837-08-28T07:34:52.325Z",
        "startedDate": "2022-10-28T07:34:52.325Z",
        "paymentDay": 0,
        "issueInvoiceDays": 0,
        "startInvoiceDate": "2022-10-28T07:34:52.325Z",
        "paymentDate": "2022-10-28T07:34:52.325Z",
        "nextIssueInvoiceDate": "2022-11-28T07:34:52.325Z",
        "nextInvoiceDate": "2022-11-28T07:34:52.325Z",
        "nextPaymentDate": "2022-11-28T07:34:52.325Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": "",
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-10-28T07:34:52.326Z",
        "updatedAt": "2022-10-28T08:00:03.386Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6365108175012",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            },
            "bigquery": {
                "lastLineItemsSynced": "2022-10-28T08:00:02.060Z",
                "lastSynced": "2022-10-28T08:00:03.386Z"
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "customer": {
            "id": "634d16dcc9d031e8c4f41674",
            "name": "Customer"
        }
    }
    ],
  "pagination": {
    "total": 1
  }
}

HTTP Request

GET /subscriptions

Query Parameters

Parameter Type Description
companyId objectId (required) Company ID
sort array Sort by field name and its ordering, e.g. sort[0]=creditNoteNo&sort[1]=-1
page integer Current page
perPage integer Number of items per pages

Create a subscription

curl "https://api.blixo.com/v1/subscriptions" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="61d68e42f8779e8cb38499be" \
-d planId="61556ed175b9f7e7b3486dac" \
-d startDate="2021-08-22T17:18:17.182Z" \
-d paymentDay=0 \
-d issueInvoiceDays=0 \
-d contractQuantity=1 \
-d contractPeriod="YEARLY" \
-d contractRenewal="AUTO_RENEW" \
-d shipTo[name]="Travis Waldron" \
-d shipTo[address1]="78 First St." \
-d addons[0][_id]="615a5cc37d3e8f4f499bd423" \
-d addons[0][name]="MEMBER ADDON YEARLY" \
-d addons[0][quantity]=1 \
-d addons[0][amount][unit]="$" \
-d addons[0][amount][currency]="USD" \
-d addons[0][amount][value]="119.88" \
-d discounts=[] \
-d taxes=[] \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63639887bc92e4015ccaa8ba",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": 2,
        "contractRenewal": "MANUALLY",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 2,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "63639887bc92e4015ccaa94e"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-03T10:31:35.875Z",
                    "toDate": "2022-12-03T10:31:35.875Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "startDate": "2022-11-03T10:31:35.875Z",
        "endDate": "2023-01-03T10:31:35.875Z",
        "startedDate": "2022-11-03T10:31:35.875Z",
        "paymentDay": 0,
        "issueInvoiceDays": 3,
        "startInvoiceDate": "2022-11-03T10:31:35.875Z",
        "paymentDate": "2022-11-03T10:31:35.875Z",
        "nextIssueInvoiceDate": "2022-11-30T10:31:35.875Z",
        "nextInvoiceDate": "2022-12-03T10:31:35.875Z",
        "nextPaymentDate": "2022-12-03T10:31:35.875Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-11-03T10:31:35.875Z",
        "updatedAt": "2022-11-03T10:31:36.895Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6244557389988",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "Custom Bundle Subscription",
                    "description": "",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    },
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

Create a new subscription profile with this endpoint.

HTTP Request

POST /subscriptions

Query Parameters

Parameter Type Description
customerId objectId (required) Customer ID
companyId objectId (required) Company ID
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
planId objectId (required) Id of subscription plan
startDate datetime Start date
paymentDay number Billing period start. Zero or day of week/month/year
issueInvoiceDays number Issue invoice x days in advance
contractQuantity number Contract terms. Default 1. Number of contract (week/month/year/custom)
contractRenewal string When contract ends. e.g. AUTO_RENEW, MANUALLY, NONE
contractPeriod string Contract period. e.g. MONTHLY, NONE
addons array An array of addons. Each addon are an object includes _id_, name, quantity, amount
taxes array An array of tax items. Each tax are an object includes _id_, name, priceInclude, amount
discounts array An array of discount items. Each item are an object includes _id_, name, amount
status string Status name. e.g. ACTIVE, CANCELED
planAmount object Plan amount object includes currency, unit, value
planQuantity number Billing period start. Zero or day of week/month/year

Update a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d planId="61556ed175b9f7e7b3486dac" \
-d startDate="2021-08-22T17:18:17.182Z" \
-d paymentDay=0 \
-d issueInvoiceDays=0 \
-d contractQuantity=1 \
-d contractPeriod="YEARLY" \
-d contractRenewal="AUTO_RENEW" \
-d shipTo[name]="Travis Waldron" \
-d shipTo[address1]="78 First St." \
-d addons[0][_id]="615a5cc37d3e8f4f499bd423" \
-d addons[0][name]="MEMBER ADDON YEARLY" \
-d addons[0][quantity]=1 \
-d addons[0][amount][unit]="$" \
-d addons[0][amount][currency]="USD" \
-d addons[0][amount][value]="119.88" \
-d discounts=[] \
-d taxes=[] \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63639887bc92e4015ccaa8ba",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": 2,
        "contractRenewal": "MANUALLY",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 2,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "63639887bc92e4015ccaa94e"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-03T10:31:35.875Z",
                    "toDate": "2022-12-03T10:31:35.875Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "startDate": "2022-11-03T10:31:35.875Z",
        "endDate": "2023-01-03T10:31:35.000Z",
        "startedDate": "2022-11-03T10:31:35.875Z",
        "paymentDay": 0,
        "issueInvoiceDays": 3,
        "startInvoiceDate": "2022-11-03T10:31:35.875Z",
        "paymentDate": "2022-11-03T10:31:35.875Z",
        "nextIssueInvoiceDate": "2022-11-30T10:31:35.875Z",
        "nextInvoiceDate": "2022-12-03T10:31:35.875Z",
        "nextPaymentDate": "2022-12-03T10:31:35.875Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-11-03T10:31:35.875Z",
        "updatedAt": "2022-11-03T10:50:19.940Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6244557389988",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "Custom Bundle Subscription",
                    "description": "",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    },
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

Update subscription with this endpoint.

HTTP Request

PATCH /subscriptions/:subscriptionId

Query Parameters

Parameter Type Description
companyId objectId (required) Company ID
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
planId objectId (required) Id of subscription plan
startDate datetime Start date
paymentDay number Billing period start. Zero or day of week/month/year
issueInvoiceDays number Issue invoice x days in advance
contractPeriod string Contract period. e.g. MONTHLY, NONE
contractQuantity number Contract terms. Default 1. Number of contract (week/month/year/custom)
contractRenewal string When contract ends. e.g. AUTO_RENEW, MANUALLY, NONE
addons array An array of addons. Each addon are an object includes _id_, name, quantity, amount
taxes array An array of tax items
discounts array An array of discount items
planAmount object Plan amount object includes currency, unit, value
planQuantity number Billing period start. Zero or day of week/month/year

Delete a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint delete a specific subscription.

HTTP Request

DELETE /subscriptions/:subscriptionId

Pause a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId/pause" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63639887bc92e4015ccaa8ba",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": 2,
        "contractRenewal": "MANUALLY",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 2,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "63639887bc92e4015ccaa94e"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-03T10:31:35.875Z",
                    "toDate": "2022-12-03T10:31:35.875Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "startDate": "2022-11-03T10:31:35.875Z",
        "endDate": "2023-01-03T10:31:35.000Z",
        "startedDate": "2022-11-03T10:31:35.875Z",
        "paymentDay": 0,
        "issueInvoiceDays": 3,
        "startInvoiceDate": "2022-11-03T10:31:35.875Z",
        "paymentDate": "2022-11-03T10:31:35.875Z",
        "nextIssueInvoiceDate": "2022-11-30T10:31:35.875Z",
        "nextInvoiceDate": "2022-12-03T10:31:35.875Z",
        "nextPaymentDate": "2022-12-03T10:31:35.875Z",
        "status": "PAUSED",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-11-03T10:31:35.875Z",
        "updatedAt": "2022-11-03T14:00:02.982Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6244557389988",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            },
            "bigquery": {
                "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                "lastSynced": "2022-11-03T12:00:03.761Z"
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "Custom Bundle Subscription",
                    "description": "",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        },
                        "bigquery": {
                            "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                            "lastSynced": "2022-11-03T12:00:03.761Z"
                        }
                    },
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint pause a specific subscription.

HTTP Request

PATCH /subscriptions/:subscriptionId/pause

Resume a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId/resume" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63639887bc92e4015ccaa8ba",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": 2,
        "contractRenewal": "MANUALLY",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 2,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "63639887bc92e4015ccaa94e"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-03T10:31:35.875Z",
                    "toDate": "2022-12-03T10:31:35.875Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "startDate": "2022-11-03T10:31:35.875Z",
        "endDate": "2023-01-03T10:31:35.000Z",
        "startedDate": "2022-11-03T10:31:35.875Z",
        "paymentDay": 0,
        "issueInvoiceDays": 3,
        "startInvoiceDate": "2022-11-03T10:31:35.875Z",
        "paymentDate": "2022-11-03T10:31:35.875Z",
        "nextIssueInvoiceDate": "2022-11-30T10:31:35.875Z",
        "nextInvoiceDate": "2022-12-04T10:31:35.875Z",
        "nextPaymentDate": "2022-12-03T10:31:35.875Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-11-03T10:31:35.875Z",
        "updatedAt": "2022-11-03T14:13:03.810Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6244557389988",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            },
            "bigquery": {
                "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                "lastSynced": "2022-11-03T12:00:03.761Z"
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "Custom Bundle Subscription",
                    "description": "",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        },
                        "bigquery": {
                            "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                            "lastSynced": "2022-11-03T12:00:03.761Z"
                        }
                    },
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint resume a specific subscription.

HTTP Request

PATCH /subscriptions/:subscriptionId/resume

Query Parameters

Parameter Type Description
nextInvoiceDate datetime (required) Next invoice date

Cancel a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId/cancel" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63639887bc92e4015ccaa8ba",
        "name": "Custom Bundle Subscription",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "635b846efd32b4015e697f0e",
        "planAmount": {
            "currency": "USD",
            "unit": "$",
            "value": 2
        },
        "planQuantity": 1,
        "contractPeriod": "MONTHLY",
        "contractQuantity": 2,
        "contractRenewal": "MANUALLY",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 2,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 2,
            "unit": "$"
        },
        "invoices": [
            "63639887bc92e4015ccaa94e"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-03T10:31:35.875Z",
                    "toDate": "2022-12-03T10:31:35.875Z",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "2",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "_id": "635b846efd32b4015e697f0e",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        }
                    }
                }
            ]
        },
        "proration": 0,
        "cancelReason": "",
        "startDate": "2022-11-03T10:31:35.875Z",
        "endDate": "2023-01-03T10:31:35.000Z",
        "startedDate": "2022-11-03T10:31:35.875Z",
        "paymentDay": 0,
        "issueInvoiceDays": 3,
        "startInvoiceDate": "2022-11-03T10:31:35.875Z",
        "paymentDate": "2022-11-03T10:31:35.875Z",
        "nextIssueInvoiceDate": "2022-11-30T10:31:35.875Z",
        "nextInvoiceDate": "2022-12-04T10:31:35.875Z",
        "nextPaymentDate": "2022-12-03T10:31:35.875Z",
        "status": "CANCELED",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "canceledAt": "2022-11-03T14:42:16.831Z",
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-11-03T10:31:35.875Z",
        "updatedAt": "2022-11-03T14:42:16.835Z",
        "source": "BLIXO",
        "integrations": {
            "shopify": {
                "customerId": "6244557389988",
                "orderId": "",
                "orderUrl": "",
                "productId": "",
                "variantId": ""
            },
            "bigquery": {
                "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                "lastSynced": "2022-11-03T12:00:03.761Z"
            }
        },
        "planDetail": {
            "code": "CUPL-00393",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": -2222,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "635b846efd32b4015e697f0e",
            "name": "2",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "USD",
                "value": 2
            },
            "createdAt": "2022-10-28T07:27:42.909Z",
            "updatedAt": "2022-10-29T06:15:44.841Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-28T08:00:02.861Z"
                }
            },
            "deletedAt": "2022-10-29T06:15:44.840Z",
            "deletedBy": "6222930b8bec060152bcad67"
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "Custom Bundle Subscription",
                    "description": "",
                    "rate": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-12-03T10:31:35.875Z",
                    "toDate": "2023-01-03T10:31:35+00:00",
                    "integrations": {
                        "shopify": {
                            "customerId": "6244557389988",
                            "orderId": "",
                            "orderUrl": "",
                            "productId": "",
                            "variantId": ""
                        },
                        "bigquery": {
                            "lastLineItemsSynced": "2022-11-03T12:00:02.214Z",
                            "lastSynced": "2022-11-03T12:00:03.761Z"
                        }
                    },
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 2,
                        "unit": "$",
                        "currency": "USD"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 2,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint cancel a specific subscription.

HTTP Request

PATCH /subscriptions/:subscriptionId/cancel

Query Parameters

Parameter Type Description
cancelNow number (required) Number of time for cancel (End of contract term/Now/Select a date). Default 1.

Reactive a subscription

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId/reactive" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "6351316327e5fd015d3a99ac",
        "name": "24 Meals",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "634f9df32b1297015d8db73c",
        "planAmount": {
            "currency": "EUR",
            "unit": "$",
            "value": 84
        },
        "planQuantity": 1,
        "contractPeriod": "YEARLY",
        "contractQuantity": 1,
        "contractRenewal": "AUTO_RENEW",
        "interval": "months",
        "intervalCount": 1,
        "billingCycle": 13,
        "addons": [
            {
                "_id": "6332a63157b074015f09208d",
                "name": "Dark Chocolate Sea Salt",
                "amount": {
                    "currency": "USD",
                    "unit": "$",
                    "value": 0
                },
                "type": "MONTHLY",
                "quantity": 8,
                "isOld": false
            },
            {
                "_id": "631741694eef1f015fc53da6",
                "name": "Strawberry Rhubarb",
                "amount": {
                    "currency": "USD",
                    "unit": "$",
                    "value": 0
                },
                "type": "MONTHLY",
                "quantity": 8,
                "isOld": false
            },
            {
                "_id": "630dcf57c755b0015e9d6b4d",
                "name": "Lemon Poppy Seed",
                "amount": {
                    "currency": "USD",
                    "unit": "$",
                    "value": 0
                },
                "type": "MONTHLY",
                "quantity": 8,
                "isOld": false
            }
        ],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "invoices": [
            "6351316327e5fd015d3a9a12"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-10-20T11:30:43.123Z",
                    "toDate": "2022-11-20T11:30:43.123Z",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-20T11:30:43.123Z",
                    "toDate": "2022-12-20T11:30:43+00:00",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "proration": 0,
        "cancelReason": "",
        "startDate": "2022-10-20T11:30:43.123Z",
        "endDate": "2022-11-30T14:55:56.113Z",
        "startedDate": "2022-10-20T11:30:43.123Z",
        "paymentDay": 0,
        "issueInvoiceDays": 2,
        "startInvoiceDate": "2022-10-20T11:30:43.123Z",
        "paymentDate": "2022-10-20T11:30:43.123Z",
        "nextIssueInvoiceDate": "2022-11-18T11:30:43.123Z",
        "nextInvoiceDate": "2022-11-20T11:30:43.123Z",
        "nextPaymentDate": "2022-11-20T11:30:43.123Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-10-20T11:30:43.124Z",
        "updatedAt": "2022-11-03T15:11:23.641Z",
        "source": "BLIXO",
        "planDetail": {
            "code": "",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": 1,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "634f9df32b1297015d8db73c",
            "name": "24 Meals",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "EUR",
                "value": 84
            },
            "createdAt": "2022-10-19T06:49:23.531Z",
            "updatedAt": "2022-10-19T08:00:02.006Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-19T08:00:02.006Z"
                }
            }
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "24 Meals",
                    "description": "",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-11-20T11:30:43.123Z",
                    "toDate": "2022-12-20T11:30:43+00:00",
                    "integrations": null,
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint reactive a specific subscription.

HTTP Request

PATCH /subscriptions/:subscriptionId/reactive

Edit schedule

curl "https://api.blixo.com/v1/subscriptions/shopify/updateInterval" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "6351316327e5fd015d3a99ac",
        "name": "24 Meals",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "634f9df32b1297015d8db73c",
        "planAmount": {
            "currency": "EUR",
            "unit": "$",
            "value": 84
        },
        "planQuantity": 1,
        "contractPeriod": "YEARLY",
        "contractQuantity": 1,
        "contractRenewal": "AUTO_RENEW",
        "interval": "years",
        "intervalCount": 3,
        "billingCycle": 1,
        "addons": [
            {
                "_id": "6332a63157b074015f09208d",
                "name": "Dark Chocolate Sea Salt",
                "amount": {
                    "currency": "USD",
                    "unit": "$",
                    "value": 0
                },
                "type": "MONTHLY",
                "quantity": 8,
                "isOld": false
            }
        ],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "invoices": [
            "6351316327e5fd015d3a9a12"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-10-20T11:30:43.123Z",
                    "toDate": "2022-11-20T11:30:43.123Z",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-10T15:25:19+00:00",
                    "toDate": "2025-11-10T15:25:19+00:00",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "proration": 0,
        "cancelReason": "",
        "startDate": "2022-10-20T11:30:43.123Z",
        "endDate": "2022-11-30T14:55:56.113Z",
        "startedDate": "2022-10-20T11:30:43.123Z",
        "paymentDay": 0,
        "issueInvoiceDays": 2,
        "startInvoiceDate": "2022-10-20T11:30:43.123Z",
        "paymentDate": "2022-10-20T11:30:43.123Z",
        "nextIssueInvoiceDate": "2022-11-10T15:25:19.962Z",
        "nextInvoiceDate": "2022-11-10T15:25:19.964Z",
        "nextPaymentDate": "2022-11-10T15:25:19.964Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-10-20T11:30:43.124Z",
        "updatedAt": "2022-11-03T15:25:28.967Z",
        "source": "BLIXO",
        "planDetail": {
            "code": "",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": 1,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "634f9df32b1297015d8db73c",
            "name": "24 Meals",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "EUR",
                "value": 84
            },
            "createdAt": "2022-10-19T06:49:23.531Z",
            "updatedAt": "2022-10-19T08:00:02.006Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-19T08:00:02.006Z"
                }
            }
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "24 Meals",
                    "description": "",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-11-10T15:25:19+00:00",
                    "toDate": "2025-11-10T15:25:19+00:00",
                    "integrations": null,
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint update interval a specific subscription.

HTTP Request

POST /subscriptions/shopify/updateInterval

Query Parameters

Parameter Type Description
subscriptionId objectId Subscription ID
nextInvoiceDate datetime (required) Date of delivery.
interval string Interval. e.g. days ,weeks, months, years
intervalCount number Number of Interval count.

Delay schedule

curl "https://api.blixo.com/v1/subscriptions/shopify/delay" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "6351316327e5fd015d3a99ac",
        "name": "24 Meals",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "634f9df32b1297015d8db73c",
        "planAmount": {
            "currency": "EUR",
            "unit": "$",
            "value": 84
        },
        "planQuantity": 1,
        "contractPeriod": "YEARLY",
        "contractQuantity": 1,
        "contractRenewal": "AUTO_RENEW",
        "interval": "years",
        "intervalCount": 3,
        "billingCycle": 1,
        "addons": [
            {
                "_id": "6332a63157b074015f09208d",
                "name": "Dark Chocolate Sea Salt",
                "amount": {
                    "currency": "USD",
                    "unit": "$",
                    "value": 0
                },
                "type": "MONTHLY",
                "quantity": 8,
                "isOld": false
            }
        ],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 84,
            "unit": "$"
        },
        "invoices": [
            "6351316327e5fd015d3a9a12"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-10-20T11:30:43.123Z",
                    "toDate": "2022-11-20T11:30:43.123Z",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-11-24T15:25:19+00:00",
                    "toDate": "2023-11-24T15:25:19+00:00",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "proration": 0,
        "cancelReason": "",
        "startDate": "2022-10-20T11:30:43.123Z",
        "endDate": "2022-11-30T14:55:56.113Z",
        "startedDate": "2022-10-20T11:30:43.123Z",
        "paymentDay": 0,
        "issueInvoiceDays": 2,
        "startInvoiceDate": "2022-10-20T11:30:43.123Z",
        "paymentDate": "2022-10-20T11:30:43.123Z",
        "nextIssueInvoiceDate": "2022-11-24T15:25:19.000Z",
        "nextInvoiceDate": "2022-11-24T15:25:19.000Z",
        "nextPaymentDate": "2022-11-24T15:25:19.000Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": "customer test",
            "attn": "customer h",
            "address1": "asdf",
            "address2": "asdf",
            "city": "asdf",
            "country": "US",
            "state": "FL",
            "zipCode": "33024"
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-10-20T11:30:43.124Z",
        "updatedAt": "2022-11-03T16:04:44.967Z",
        "source": "BLIXO",
        "planDetail": {
            "code": "",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": 1,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "634f9df32b1297015d8db73c",
            "name": "24 Meals",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "EUR",
                "value": 84
            },
            "createdAt": "2022-10-19T06:49:23.531Z",
            "updatedAt": "2022-10-19T08:00:02.006Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-19T08:00:02.006Z"
                }
            }
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "24 Meals",
                    "description": "",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2022-11-24T15:25:19+00:00",
                    "toDate": "2023-11-24T15:25:19+00:00",
                    "integrations": null,
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        },
        "customer": {
            "id": "62f135085ff37c016a57f0eb",
            "name": "customer test"
        }
    }
}

This endpoint delay a specific subscription.

HTTP Request

POST /subscriptions/shopify/delay

Query Parameters

Parameter Type Description
intervalCount number (required) Number of Interval count.
subscriptionId objectId Subscription ID
interval string Interval. e.g. days ,weeks, months, years

Charge now

curl "https://api.blixo.com/v1/subscriptions/shopify/shipNow" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": [
        {
            "id": "6351316327e5fd015d3a99ac",
            "name": "24 Meals",
            "subscriptionNo": "",
            "companyId": "622294998bec060152bcad9c",
            "customerId": "62f135085ff37c016a57f0eb",
            "planId": "634f9df32b1297015d8db73c",
            "planAmount": {
                "currency": "EUR",
                "unit": "$",
                "value": 84
            },
            "planQuantity": 1,
            "contractPeriod": "YEARLY",
            "contractQuantity": 1,
            "contractRenewal": "AUTO_RENEW",
            "interval": "years",
            "intervalCount": 3,
            "billingCycle": 1,
            "addons": [],
            "discounts": [],
            "taxes": [],
            "shippings": [],
            "shippingAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "discountAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "taxAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "subTotalAmount": {
                "currency": "EUR",
                "value": 84,
                "unit": "$"
            },
            "totalAmount": {
                "currency": "EUR",
                "value": 84,
                "unit": "$"
            },
            "invoices": [
                "6351316327e5fd015d3a9a12"
            ],
            "currentInvoice": {
                "items": [
                    {
                        "name": "24 Meals",
                        "rate": {
                            "value": 84,
                            "unit": "$",
                            "currency": "EUR"
                        },
                        "quantity": 1,
                        "taxable": true,
                        "type": "Plan",
                        "fromDate": "2022-10-20T11:30:43.123Z",
                        "toDate": "2022-11-20T11:30:43.123Z",
                        "_id": "634f9df32b1297015d8db73c",
                        "integrations": null
                    }
                ]
            },
            "upcomingInvoice": {
                "items": [
                    {
                        "name": "24 Meals",
                        "rate": {
                            "value": 84,
                            "unit": "$",
                            "currency": "EUR"
                        },
                        "quantity": 1,
                        "taxable": true,
                        "type": "Plan",
                        "fromDate": "2022-11-04T16:27:30+00:00",
                        "toDate": "2023-11-04T16:27:30+00:00",
                        "_id": "634f9df32b1297015d8db73c",
                        "integrations": null
                    }
                ]
            },
            "proration": 0,
            "cancelReason": "",
            "startDate": "2022-10-20T11:30:43.123Z",
            "endDate": "2025-10-20T11:30:43.000Z",
            "startedDate": "2022-10-20T11:30:43.123Z",
            "paymentDay": 0,
            "issueInvoiceDays": 2,
            "startInvoiceDate": "2022-10-20T11:30:43.123Z",
            "paymentDate": "2022-10-20T11:30:43.123Z",
            "nextIssueInvoiceDate": "2022-11-04T16:27:30.000Z",
            "nextInvoiceDate": "2022-11-06T16:27:30.000Z",
            "nextPaymentDate": "2022-11-06T16:27:30.000Z",
            "status": "ACTIVE",
            "oldPlanId": null,
            "oldPlanAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "shipTo": {
                "name": " ",
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "zipCode": "",
                "country": "",
                "phones": [
                    ""
                ]
            },
            "cancelAtPeriodEnd": false,
            "customerFromPortal": false,
            "createdAt": "2022-10-20T11:30:43.124Z",
            "updatedAt": "2022-11-03T16:27:30.972Z",
            "source": "BLIXO",
            "planDetail": {
                "code": "",
                "type": "CUSTOM",
                "itemId": null,
                "interval": "months",
                "intervalCount": 1,
                "pricingMode": "per_unit",
                "taxable": true,
                "isTemplate": false,
                "_id": "634f9df32b1297015d8db73c",
                "name": "24 Meals",
                "companyId": "622294998bec060152bcad9c",
                "price": {
                    "unit": "$",
                    "currency": "EUR",
                    "value": 84
                },
                "createdAt": "2022-10-19T06:49:23.531Z",
                "updatedAt": "2022-10-19T08:00:02.006Z",
                "__v": 0,
                "integrations": {
                    "bigquery": {
                        "lastSynced": "2022-10-19T08:00:02.006Z"
                    }
                }
            },
            "upcomingInvoiceDetail": {
                "items": [
                    {
                        "amount": {
                            "value": 84,
                            "unit": "$",
                            "currency": "EUR"
                        },
                        "companyId": "622294998bec060152bcad9c",
                        "discountable": false,
                        "hasDefaultPrice": false,
                        "interval": "months",
                        "intervalCount": 1,
                        "itemId": null,
                        "name": "24 Meals",
                        "description": "",
                        "rate": {
                            "value": 84,
                            "unit": "$",
                            "currency": "EUR"
                        },
                        "quantity": 1,
                        "pricingMode": "per_unit",
                        "taxable": true,
                        "taxes": [],
                        "type": "Plan",
                        "itemType": "NONE",
                        "fromDate": "2022-11-04T16:27:30+00:00",
                        "toDate": "2023-11-04T16:27:30+00:00",
                        "integrations": null,
                        "discountAmount": {
                            "value": 0,
                            "unit": "$"
                        },
                        "discountedAmount": {
                            "value": 84,
                            "unit": "$",
                            "currency": "EUR"
                        }
                    }
                ],
                "subTotalAmount": {
                    "value": 84,
                    "unit": "$",
                    "currency": "USD"
                },
                "discountAmount": {
                    "value": 0,
                    "unit": "$",
                    "currency": "USD"
                },
                "taxAmount": {
                    "value": 0,
                    "unit": "$",
                    "currency": "USD"
                },
                "taxLines": [],
                "totalAmount": {
                    "value": 84,
                    "unit": "$",
                    "currency": "USD"
                },
                "shippingAmount": {
                    "value": 0,
                    "unit": "$"
                },
                "shippingLines": [],
                "discountLines": []
            }
        }
    ]
}

This endpoint charge a specific subscription.

HTTP Request

POST /subscriptions/shopify/shipNow

Query Parameters

Parameter Type Description
subscriptionIds array (required) List of subscription ID

Skip next billing

curl "https://api.blixo.com/v1/subscriptions/:subscriptionId/skip" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "6351316327e5fd015d3a99ac",
        "name": "24 Meals",
        "subscriptionNo": "",
        "companyId": "622294998bec060152bcad9c",
        "customerId": "62f135085ff37c016a57f0eb",
        "planId": "634f9df32b1297015d8db73c",
        "planAmount": {
            "currency": "EUR",
            "unit": "$",
            "value": 84
        },
        "planQuantity": 1,
        "contractPeriod": "YEARLY",
        "contractQuantity": 1,
        "contractRenewal": "AUTO_RENEW",
        "interval": "years",
        "intervalCount": 3,
        "billingCycle": 1,
        "addons": [],
        "discounts": [],
        "taxes": [],
        "shippings": [],
        "shippingAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "discountAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "taxAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "subTotalAmount": {
            "currency": "EUR",
            "value": 84,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "EUR",
            "value": 84,
            "unit": "$"
        },
        "invoices": [
            "6351316327e5fd015d3a9a12"
        ],
        "currentInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2022-10-20T11:30:43.123Z",
                    "toDate": "2022-11-20T11:30:43.123Z",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "upcomingInvoice": {
            "items": [
                {
                    "name": "24 Meals",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "taxable": true,
                    "type": "Plan",
                    "fromDate": "2023-11-20T16:27:30+00:00",
                    "toDate": "2024-11-20T16:27:30+00:00",
                    "_id": "634f9df32b1297015d8db73c",
                    "integrations": null
                }
            ]
        },
        "proration": 0,
        "cancelReason": "",
        "startDate": "2022-10-20T11:30:43.123Z",
        "endDate": "2025-10-20T11:30:43.000Z",
        "startedDate": "2022-10-20T11:30:43.123Z",
        "paymentDay": 0,
        "issueInvoiceDays": 2,
        "startInvoiceDate": "2022-10-20T11:30:43.123Z",
        "paymentDate": "2022-10-20T11:30:43.123Z",
        "nextIssueInvoiceDate": "2023-11-18T16:27:30.000Z",
        "nextInvoiceDate": "2023-11-20T16:27:30.000Z",
        "nextPaymentDate": "2023-11-20T16:27:30.000Z",
        "status": "ACTIVE",
        "oldPlanId": null,
        "oldPlanAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "shipTo": {
            "name": " ",
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "",
            "phones": [
                ""
            ]
        },
        "cancelAtPeriodEnd": false,
        "customerFromPortal": false,
        "createdAt": "2022-10-20T11:30:43.124Z",
        "updatedAt": "2022-11-03T17:01:47.672Z",
        "source": "BLIXO",
        "planDetail": {
            "code": "",
            "type": "CUSTOM",
            "itemId": null,
            "interval": "months",
            "intervalCount": 1,
            "pricingMode": "per_unit",
            "taxable": true,
            "isTemplate": false,
            "_id": "634f9df32b1297015d8db73c",
            "name": "24 Meals",
            "companyId": "622294998bec060152bcad9c",
            "price": {
                "unit": "$",
                "currency": "EUR",
                "value": 84
            },
            "createdAt": "2022-10-19T06:49:23.531Z",
            "updatedAt": "2022-10-19T08:00:02.006Z",
            "__v": 0,
            "integrations": {
                "bigquery": {
                    "lastSynced": "2022-10-19T08:00:02.006Z"
                }
            }
        },
        "upcomingInvoiceDetail": {
            "items": [
                {
                    "amount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "companyId": "622294998bec060152bcad9c",
                    "discountable": false,
                    "hasDefaultPrice": false,
                    "interval": "months",
                    "intervalCount": 1,
                    "itemId": null,
                    "name": "24 Meals",
                    "description": "",
                    "rate": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    },
                    "quantity": 1,
                    "pricingMode": "per_unit",
                    "taxable": true,
                    "taxes": [],
                    "type": "Plan",
                    "itemType": "NONE",
                    "fromDate": "2023-11-20T16:27:30+00:00",
                    "toDate": "2024-11-20T16:27:30+00:00",
                    "integrations": null,
                    "discountAmount": {
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "value": 84,
                        "unit": "$",
                        "currency": "EUR"
                    }
                }
            ],
            "subTotalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "discountAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxAmount": {
                "value": 0,
                "unit": "$",
                "currency": "USD"
            },
            "taxLines": [],
            "totalAmount": {
                "value": 84,
                "unit": "$",
                "currency": "USD"
            },
            "shippingAmount": {
                "value": 0,
                "unit": "$"
            },
            "shippingLines": [],
            "discountLines": []
        }
    }
}

This endpoint skip a specific subscription.

HTTP Request

PATCH /subscriptions/:subscriptionId/skip

Import subcriptions

curl "https://api.blixo.com/v1/imports/importCSV/subscriptions" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

 {
        "id": "6363f575bc92e4015cccfb6e",
        "integration": "BLIXO",
        "companyId": "622294998bec060152bcad9c",
        "type": "subscriptions",
        "name": "Subscriptions from CSV",
        "message": "",
        "numFailed": 0,
        "numUpdated": 0,
        "numCreated": 0,
        "totalRecords": 0,
        "status": "IMPORTING",
        "importParams": null,
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-03T17:08:05.938Z",
        "updatedAt": "2022-11-03T17:08:05.938Z"
    }

This endpoint import subscriptions.

HTTP Request

POST /imports/importCSV/subscriptions

Quotes

List all quotes

curl "https://api.blixo.com/v1/quotes" \
-u {API_KEY}:

The above command returns JSON structured like this:

{
    "data": [
        {
            "id": "632899edac3a1aa3b3eaeac7",
            "quoteNo": "QTE-0004",
            "managerId": null,
            "issueDate": "2022-09-19T16:33:36.947Z",
            "expireDate": "2022-09-19T16:33:36.947Z",
            "billTo": {
                "attn": "",
                "phones": [],
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "zipCode": "",
                "country": "",
                "name": ""
            },
            "notes": "",
            "attachments": [
                ""
            ],
            "subTotalAmount": {
                "currency": "USD",
                "_id": "632899eeac3a1aa3b3eaeadc",
                "value": 100,
                "unit": "$"
            },
            "totalAmount": {
                "currency": "USD",
                "value": 100,
                "unit": "$"
            },
            "balanceAmount": {
                "currency": "USD",
                "value": 100,
                "unit": "$"
            },
            "quoteStatus": [
                "ISSUED"
            ],
            "sentStatus": "NOT_SENT",
            "itemLines": [
                {
                    "detail": null,
                    "_id": "632899e059848c7fd4ab3907",
                    "title": "test",
                    "description": "",
                    "quantity": 1,
                    "rate": {
                        "currency": "USD",
                        "_id": "632899edac3a1aa3b3eaeac9",
                        "unit": "$",
                        "value": 100
                    },
                    "amount": {
                        "currency": "USD",
                        "_id": "632899eeac3a1aa3b3eaead8",
                        "value": 100,
                        "unit": "$"
                    },
                    "taxLines": [],
                    "discountLines": [],
                    "discountAmount": {
                        "currency": "USD",
                        "_id": "632899eeac3a1aa3b3eaead6",
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "currency": "USD",
                        "_id": "632899eeac3a1aa3b3eaead7",
                        "value": 100,
                        "unit": "$"
                    }
                }
            ],
            "discountLines": [],
            "discountAmount": {
                "currency": "USD",
                "_id": "632899eeac3a1aa3b3eaead9",
                "value": 0,
                "unit": "$"
            },
            "discountedAmount": {
                "currency": "USD",
                "_id": "632899eeac3a1aa3b3eaeada",
                "value": 100,
                "unit": "$"
            },
            "taxLines": [],
            "taxAmount": {
                "currency": "USD",
                "_id": "632899eeac3a1aa3b3eaeadb",
                "value": 0,
                "unit": "$"
            },
            "companyId": "622294998bec060152bcad9c",
            "customerId": "63243a6864c52f1156d665d0",
            "shippingLines": [],
            "shippingAmount": {
                "currency": "USD",
                "_id": "632899eeac3a1aa3b3eaeadd",
                "value": 0,
                "unit": "$"
            },
            "createdBy": "6222930b8bec060152bcad67",
            "updatedBy": "6222930b8bec060152bcad67",
            "createdAt": "2022-09-19T16:33:49.499Z",
            "updatedAt": "2022-09-19T16:33:51.298Z",
            "source": "BLIXO",
            "initial": "",
            "signatureUrl": "",
            "approvalDetail": null,
            "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
            "invoice": null,
            "transactions": []
        }
    ],
    "pagination": {
        "total": 1
    }
}

This endpoint retrieves all quotes.

HTTP Request

GET /quotes

Query Parameters

Parameter Type Description
quoteStatus array Quote Status, e.g. ISSUED, DRAFT, CLOSED
sort array Sort by field name and its ordering, e.g. sort[0]=invoiceNo&sort[1]=-1
page integer Current page
perPage integer Number of items per pages

Create a quote

curl "https://api.blixo.com/v1/quotes" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="61d68e42f8779e8cb38499be" \
-d issueDate="2021-08-22T17:18:17.182Z" \
-d expireDate="2021-08-22T17:18:17.182Z" \
-d contractTerms="Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses." \
-d notes="notes" \
-d quoteNo="3223232" \
-d quoteStatus[0]="ISSUED" \
-d shipTo[name]="Travis Waldron" \
-d shipTo[address1]="" \
-d shipTo[address2]="" \
-d shipTo[attn]="" \
-d shipTo[city]="" \
-d shipTo[country]="" \
-d shipTo[zipCode]="" \
-d shipTo[state]="" \
-d itemLines[0][_id]="615a5cc37d3e8f4f499bd423" \
-d itemLines[0][description]="MEMBER ADDON YEARLY" \
-d itemLines[0][title]="Title" \
-d itemLines[0][quantity]=1 \
-d itemLines[0][amount][unit]="$" \
-d itemLines[0][amount][value]="119.88" \
-d itemLines[0][rate][unit]="$" \
-d itemLines[0][rate][value]="119.88" \
-d depositAmount[currency]="USD" \
-d depositAmount[unit]="$" \
-d depositAmount[value]="" \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63649a7ebc92e4015cd12bc7",
        "quoteNo": "3223232",
        "managerId": null,
        "issueDate": "2022-11-04T04:51:12.993Z",
        "expireDate": "2022-11-04T04:51:12.993Z",
        "notes": "45324634453536353941433339384332:2044a5fffdd9cbe1557b4354efcf14ba",
        "subTotalAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12be1",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": -3232,
            "unit": "$"
        },
        "quoteStatus": [
            "ISSUED"
        ],
        "sentStatus": "NOT_SENT",
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12bde",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12bdf",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12be0",
            "value": 0,
            "unit": "$"
        },
        "depositAmount": {
            "currency": "USD",
            "_id": "63649a7ebc92e4015cd12bcb",
            "unit": "$",
            "value": 3232
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12be2",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-04T04:52:14.936Z",
        "updatedAt": "2022-11-04T04:52:15.020Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": null,
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "invoice": null
    }
}

Create a new quote with this endpoint.

HTTP Request

POST /quotes

Query Parameters

Parameter Type Description
issueDate datetime (required) Issue date
customerId objectId (required) Customer ID
quoteNo string Quote number
quoteStatus array Quote Status, e.g. ISSUED, DRAFT, CLOSED
companyId objectId Company ID
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, taxLines,integrations, amount, rate
expireDate datetime Expire date
contractTerms string Contract Terms
depositAmount object Deposit Amount object includes currency, unit, value
notes string Notes

Update a quote

curl "https://api.blixo.com/v1/quotes/:quoteId" \
-u {API_KEY}: \
-d companyId="60e1b7f0c6ef4219ff51824c" \
-d customerId="61d68e42f8779e8cb38499be" \
-d issueDate="2021-08-22T17:18:17.182Z" \
-d expireDate="2021-08-22T17:18:17.182Z" \
-d contractTerms="Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses." \
-d notes="notes" \
-d quoteNo="3223232" \
-d quoteStatus[0]="ISSUED" \
-d shipTo[name]="Travis Waldron" \
-d shipTo[address1]="" \
-d shipTo[address2]="" \
-d shipTo[attn]="" \
-d shipTo[city]="" \
-d shipTo[country]="" \
-d shipTo[zipCode]="" \
-d shipTo[state]="" \
-d itemLines[0][_id]="615a5cc37d3e8f4f499bd423" \
-d itemLines[0][description]="MEMBER ADDON YEARLY" \
-d itemLines[0][title]="Title" \
-d itemLines[0][quantity]=1 \
-d itemLines[0][amount][unit]="$" \
-d itemLines[0][amount][value]="119.88" \
-d itemLines[0][rate][unit]="$" \
-d itemLines[0][rate][value]="119.88" \
-d depositAmount[currency]="USD" \
-d depositAmount[unit]="$" \
-d depositAmount[value]="" \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "63649a7ebc92e4015cd12bc7",
        "quoteNo": "3223232",
        "managerId": null,
        "issueDate": "2022-11-04T04:51:12.993Z",
        "expireDate": "2022-11-04T04:51:12.993Z",
        "billTo": {
            "attn": "customer",
            "phones": [],
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "DE",
            "integrations": {
                "shopify": {
                    "addressId": "7571863634084"
                }
            },
            "name": "customer"
        },
        "shipTo": {
            "name": "customertest99",
            "attn": "customer",
            "address1": "Address 1",
            "address2": "2323",
            "country": "DE",
            "city": "Address 2",
            "state": "76543",
            "zipCode": "1"
        },
        "notes": "3434343",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "currency": "USD",
            "_id": "6364c292bc92e4015cd20c48",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": -3232,
            "unit": "$"
        },
        "quoteStatus": [
            "ISSUED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [
            {
                "detail": null,
                "_id": "63649a40a135707610508976",
                "title": "3434",
                "description": "",
                "quantity": 1,
                "rate": {
                    "currency": "USD",
                    "_id": "63649a7ebc92e4015cd12bc9",
                    "value": 0,
                    "unit": "$"
                },
                "amount": {
                    "currency": "USD",
                    "_id": "6364c292bc92e4015cd20c42",
                    "value": 0,
                    "unit": "$"
                },
                "taxLines": [],
                "discountLines": [],
                "discountAmount": {
                    "currency": "USD",
                    "_id": "6364c292bc92e4015cd20c40",
                    "value": 0,
                    "unit": "$"
                },
                "discountedAmount": {
                    "currency": "USD",
                    "_id": "6364c292bc92e4015cd20c41",
                    "value": 0,
                    "unit": "$"
                }
            }
        ],
        "discountLines": [
            {
                "_id": "6329dc5985cd80015e9c0b51",
                "name": "NGUYEN",
                "amount": {
                    "currency": "USD",
                    "_id": "6329dc5985cd80015e9c0b52",
                    "unit": "%",
                    "value": 10
                }
            }
        ],
        "discountAmount": {
            "currency": "USD",
            "_id": "6364c292bc92e4015cd20c46",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "6364c292bc92e4015cd20c47",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "63649a7fbc92e4015cd12be0",
            "value": 0,
            "unit": "$"
        },
        "depositAmount": {
            "currency": "USD",
            "_id": "6364c292bc92e4015cd20c2f",
            "unit": "$",
            "value": 3232
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "6364c292bc92e4015cd20c49",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-04T04:52:14.936Z",
        "updatedAt": "2022-11-04T07:43:14.682Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": null,
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "invoice": null,
        "transactions": []
    }
}

Update a quote with this endpoint.

HTTP Request

PATCH /quotes/:quoteId

Query Parameters

Parameter Type Description
issueDate datetime (required) Issue date
customerId objectId Customer ID
quoteNo string Quote number
quoteStatus array Quote Status, e.g. ISSUED, DRAFT, CLOSED
companyId objectId Company ID
billTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode, integrations, name
shipTo object Address object includes address1, address2, attn, city, country, phones, state, zipCode
itemLines array An array of items. Each item are an object includes title, description, quantity, rate, taxLines,integrations, amount, rate
expireDate datetime Expire date
contractTerms string Contract Terms
depositAmount object Deposit Amount object includes currency, unit, value
subTotalAmount object Sub total Amount object includes currency, unit, value
taxAmount object Tax amount object includes _id, currency, unit, value
shippingAmount object Shipping amount object includes _id, currency, unit, `value
notes string Notes
updatedAt datetime Updated date
updatedBy string Updated by id
totalAmount object Total amount object includes currency, unit, value
taxLines array Tax line items
sentStatus string Quote sent status, e.g. SENT or NOT_SENT
discountedAmount object Discounted amount object includes currency, unit, value

Delete a quote

curl "https://api.blixo.com/v1/quotes/:quoteId" \
-u {API_KEY}: \
-X DELETE

The above command returns JSON structured like this:

{
  "data": "611d4216a747250146ade2cf"
}

This endpoint deletes a specific quote.

HTTP Request

DELETE /quotes/:quoteId

Download a quote

curl "https://api.blixo.com/v1/quotes/:quoteId/actions/download" \
-u {API_KEY}: \
-X GET \
-o quote.pdf

Download a quote with this endpoint.

HTTP Request

GET /quotes/:quoteId/actions/download

Send a quote

curl "https://api.blixo.com/v1/quotes/:quoteId/send" \
-d to="[email protected]" \
-d bcc="[email protected]" \
-d subject="{{company_name}} Quote {{quote_number}} for {{customer_name}}" \
-d message="Hi {{customer_contact_name}},
We prepared Quote #{{quote_number}} for you. We kindly ask that you review the quote as soon as you can.
If you have questions about this quote, please contact us at {{company_email}} or reply to this email.
We look forward to doing business with you.
{{view_approve_quote_button}}" \
-X POST

Send a quote with this endpoint.

HTTP Request

POST /quotes/:quoteId/send

Query Parameters

Parameter Type Description
to email (required) Receiver's email
bcc email Bcc email
subject string (required) Email subject
message string (required) Email message

Convert to invoice

curl "https://api.blixo.com/v1/quotes/:quoteId/actions/convertToInvoice" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "6364bcffbc92e4015cd205a9",
        "quoteNo": "QTE-0006",
        "managerId": null,
        "issueDate": "2022-11-04T07:15:35.258Z",
        "expireDate": "2022-11-04T07:15:35.258Z",
        "notes": "45324634453536353941433339384332:0a30a6b59f01a267e4cb2fdd9b6f7eb9",
        "subTotalAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205c4",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": -23,
            "unit": "$"
        },
        "quoteStatus": [
            "INVOICED",
            "CLOSED"
        ],
        "sentStatus": "SENT",
        "discountLines": [
            {
                "_id": "6329dc5985cd80015e9c0b51",
                "name": "NGUYEN",
                "amount": {
                    "currency": "USD",
                    "_id": "6329dc5985cd80015e9c0b52",
                    "unit": "%",
                    "value": 10
                }
            }
        ],
        "discountAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205c1",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205c2",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205c3",
            "value": 0,
            "unit": "$"
        },
        "depositAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205ae",
            "unit": "$",
            "value": 23
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6331629360eea3015e855e40",
        "invoiceId": "6364ca54bc92e4015cd2b7c3",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "6364bcffbc92e4015cd205c5",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-11-04T07:19:27.655Z",
        "updatedAt": "2022-11-04T08:16:20.805Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": null,
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "transactions": [],
        "invoice": {
            "invoiceNo": "INV-4261",
            "managerId": null,
            "notes": "",
            "attachments": [
                ""
            ],
            "paymentStatus": [
                "PAID"
            ],
            "invoiceStatus": [
                "CLOSED"
            ],
            "sentStatus": "NOT_SENT",
            "disableChasing": true,
            "useCustomerEmail": true,
            "invoiceEmail": "",
            "source": "BLIXO",
            "isPaymentPlan": false,
            "paymentPlanAutoPay": false,
            "requireApprove": false,
            "approvalDetail": null,
            "attemptCount": 0,
            "_id": "6364ca54bc92e4015cd2b7c3",
            "discountLines": [
                {
                    "_id": "6329dc5985cd80015e9c0b51",
                    "name": "NGUYEN",
                    "amount": {
                        "currency": "USD",
                        "_id": "6329dc5985cd80015e9c0b52",
                        "unit": "%",
                        "value": 10
                    }
                }
            ],
            "taxLines": [],
            "shippingLines": [],
            "chasingSchedules": [],
            "installments": [],
            "issueDate": "2022-11-04T08:16:20.681Z",
            "paymentTerms": "AUTO_PAY",
            "companyId": "622294998bec060152bcad9c",
            "customerId": "6331629360eea3015e855e40",
            "createdAt": "2022-11-04T08:16:20.688Z",
            "updatedAt": "2022-11-04T08:16:20.774Z",
            "__enc_billTo_d": "",
            "__enc_billTo": false,
            "__enc_shipTo_d": "",
            "__enc_shipTo": false,
            "__enc_attachments_d": "",
            "__enc_attachments": false,
            "__enc_itemLines_d": "",
            "__enc_itemLines": false,
            "__v": 1,
            "balanceAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "creditAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7e3",
                "value": 0,
                "unit": "$"
            },
            "discountAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7db",
                "value": 0,
                "unit": "$"
            },
            "discountedAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7dc",
                "value": 0,
                "unit": "$"
            },
            "paidAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7e2",
                "value": 0,
                "unit": "$"
            },
            "paidDate": "2022-11-04T08:16:20.770Z",
            "shippingAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7df",
                "value": 0,
                "unit": "$"
            },
            "subTotalAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7de",
                "value": 0,
                "unit": "$"
            },
            "taxAmount": {
                "currency": "USD",
                "_id": "6364ca54bc92e4015cd2b7dd",
                "value": 0,
                "unit": "$"
            },
            "totalAmount": {
                "currency": "USD",
                "value": 0,
                "unit": "$"
            },
            "itemLines": [
                {
                    "detail": null,
                    "_id": "6364bc17a1f539afd72f36be",
                    "title": "ádfgh",
                    "description": "",
                    "quantity": 1,
                    "rate": {
                        "currency": "USD",
                        "_id": "6364bcffbc92e4015cd205ab",
                        "value": 0,
                        "unit": "$"
                    },
                    "amount": {
                        "currency": "USD",
                        "_id": "6364ca54bc92e4015cd2b7da",
                        "value": 0,
                        "unit": "$"
                    },
                    "taxLines": [],
                    "discountLines": [],
                    "discountAmount": {
                        "currency": "USD",
                        "_id": "6364ca54bc92e4015cd2b7d8",
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "currency": "USD",
                        "_id": "6364ca54bc92e4015cd2b7d9",
                        "value": 0,
                        "unit": "$"
                    }
                }
            ],
            "billTo": {
                "attn": "customer",
                "phones": [],
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "zipCode": "",
                "country": "DE",
                "integrations": {
                    "shopify": {
                        "addressId": "7571863634084"
                    }
                },
                "name": "customer"
            },
            "shipTo": {
                "name": "customer",
                "attn": "customer",
                "address1": "",
                "address2": "",
                "country": "DE",
                "city": "",
                "state": "",
                "zipCode": ""
            }
        }
    }
}

This endpoint convert a specific quote to invoice.

HTTP Request

POST quotes/:quoteId/actions/convertToInvoice

Mark as approved

curl "https://api.blixo.com/v1/quotes/:quoteId/actions/markApproved" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "632899edac3a1aa3b3eaeac7",
        "quoteNo": "QTE-0004",
        "managerId": null,
        "issueDate": "2022-09-19T16:33:36.947Z",
        "expireDate": "2022-09-19T16:33:36.947Z",
        "notes": "",
        "subTotalAmount": {
            "currency": "USD",
            "_id": "632899eeac3a1aa3b3eaeadc",
            "value": 100,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 100,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": 100,
            "unit": "$"
        },
        "quoteStatus": [
            "INVOICED",
            "CLOSED"
        ],
        "sentStatus": "NOT_SENT",
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "632899eeac3a1aa3b3eaead9",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "632899eeac3a1aa3b3eaeada",
            "value": 100,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "632899eeac3a1aa3b3eaeadb",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "63243a6864c52f1156d665d0",
        "invoiceId": "6364cc52bc92e4015cd2bb0b",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "632899eeac3a1aa3b3eaeadd",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-09-19T16:33:49.499Z",
        "updatedAt": "2022-11-04T08:24:50.499Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": {
            "ip": "116.109.9.246",
            "client": {
                "ua": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36",
                "browser": {
                    "name": "Chrome",
                    "version": "106.0.0.0",
                    "major": "106"
                },
                "engine": {
                    "name": "Blink",
                    "version": "106.0.0.0"
                },
                "os": {
                    "name": "Mac OS",
                    "version": "10.15.7"
                },
                "device": {},
                "cpu": {}
            },
            "timestamp": "2022-11-04T08:24:50.413Z"
        },
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "transactions": [],
        "invoice": {
            "invoiceNo": "INV-4262",
            "managerId": null,
            "notes": "",
            "attachments": [
                ""
            ],
            "paymentStatus": [
                "OUTSTANDING"
            ],
            "invoiceStatus": [
                "ISSUED"
            ],
            "sentStatus": "NOT_SENT",
            "disableChasing": true,
            "useCustomerEmail": true,
            "invoiceEmail": "",
            "source": "BLIXO",
            "isPaymentPlan": false,
            "paymentPlanAutoPay": false,
            "requireApprove": false,
            "approvalDetail": null,
            "attemptCount": 0,
            "_id": "6364cc52bc92e4015cd2bb0b",
            "discountLines": [],
            "taxLines": [],
            "shippingLines": [],
            "chasingSchedules": [],
            "installments": [],
            "issueDate": "2022-11-04T08:24:50.436Z",
            "paymentTerms": "AUTO_PAY",
            "companyId": "622294998bec060152bcad9c",
            "customerId": "63243a6864c52f1156d665d0",
            "createdAt": "2022-11-04T08:24:50.439Z",
            "updatedAt": "2022-11-04T08:24:50.477Z",
            "__enc_billTo_d": "",
            "__enc_billTo": false,
            "__enc_attachments_d": "",
            "__enc_attachments": false,
            "__enc_itemLines_d": "",
            "__enc_itemLines": false,
            "__v": 0,
            "balanceAmount": {
                "currency": "USD",
                "value": 100,
                "unit": "$"
            },
            "creditAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb30",
                "value": 0,
                "unit": "$"
            },
            "discountAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb28",
                "value": 0,
                "unit": "$"
            },
            "discountedAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb29",
                "value": 100,
                "unit": "$"
            },
            "paidAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb2f",
                "value": 0,
                "unit": "$"
            },
            "paidDate": null,
            "shippingAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb2c",
                "value": 0,
                "unit": "$"
            },
            "subTotalAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb2b",
                "value": 100,
                "unit": "$"
            },
            "taxAmount": {
                "currency": "USD",
                "_id": "6364cc52bc92e4015cd2bb2a",
                "value": 0,
                "unit": "$"
            },
            "totalAmount": {
                "currency": "USD",
                "value": 100,
                "unit": "$"
            },
            "itemLines": [
                {
                    "detail": null,
                    "_id": "632899e059848c7fd4ab3907",
                    "title": "test",
                    "description": "",
                    "quantity": 1,
                    "rate": {
                        "currency": "USD",
                        "_id": "632899edac3a1aa3b3eaeac9",
                        "unit": "$",
                        "value": 100
                    },
                    "amount": {
                        "currency": "USD",
                        "_id": "6364cc52bc92e4015cd2bb27",
                        "value": 100,
                        "unit": "$"
                    },
                    "taxLines": [],
                    "discountLines": [],
                    "discountAmount": {
                        "currency": "USD",
                        "_id": "6364cc52bc92e4015cd2bb25",
                        "value": 0,
                        "unit": "$"
                    },
                    "discountedAmount": {
                        "currency": "USD",
                        "_id": "6364cc52bc92e4015cd2bb26",
                        "value": 100,
                        "unit": "$"
                    }
                }
            ],
            "billTo": {
                "attn": "",
                "phones": [],
                "address1": "",
                "address2": "",
                "city": "",
                "state": "",
                "zipCode": "",
                "country": "",
                "name": ""
            }
        }
    }
}

Mark a quote has been approved with this endpoint.

HTTP Request

POST /quotes/:quoteId/actions/markApproved

Close a quote

curl "https://api.blixo.com/v1/quotes/:quoteId/actions/close" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63289763ac3a1aa3b3ead120",
        "quoteNo": "QTE-0003",
        "managerId": null,
        "issueDate": "2022-09-19T16:22:51.768Z",
        "expireDate": "2022-09-19T16:22:51.768Z",
        "billTo": {
            "attn": "",
            "phones": [],
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "",
            "name": ""
        },
        "notes": "",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12c",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "quoteStatus": [
            "DRAFT",
            "CLOSED",
            "DECLINED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [],
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead129",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12a",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12b",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6324b0af2eaf9a51dee5307e",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12d",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-09-19T16:22:59.353Z",
        "updatedAt": "2022-11-04T08:32:03.460Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": null,
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "invoice": null,
        "transactions": []
    }
}

Close a quote with this endpoint.

HTTP Request

POST /quotes/:quoteId/actions/close

Void a quote

curl "https://api.blixo.com/v1/quotes/:quoteId/actions/void" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "data": {
        "id": "63289763ac3a1aa3b3ead120",
        "quoteNo": "QTE-0003",
        "managerId": null,
        "issueDate": "2022-09-19T16:22:51.768Z",
        "expireDate": "2022-09-19T16:22:51.768Z",
        "billTo": {
            "attn": "",
            "phones": [],
            "address1": "",
            "address2": "",
            "city": "",
            "state": "",
            "zipCode": "",
            "country": "",
            "name": ""
        },
        "notes": "",
        "attachments": [
            ""
        ],
        "subTotalAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12c",
            "value": 0,
            "unit": "$"
        },
        "totalAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "balanceAmount": {
            "currency": "USD",
            "value": 0,
            "unit": "$"
        },
        "quoteStatus": [
            "VOIDED"
        ],
        "sentStatus": "NOT_SENT",
        "itemLines": [],
        "discountLines": [],
        "discountAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead129",
            "value": 0,
            "unit": "$"
        },
        "discountedAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12a",
            "value": 0,
            "unit": "$"
        },
        "taxLines": [],
        "taxAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12b",
            "value": 0,
            "unit": "$"
        },
        "companyId": "622294998bec060152bcad9c",
        "customerId": "6324b0af2eaf9a51dee5307e",
        "shippingLines": [],
        "shippingAmount": {
            "currency": "USD",
            "_id": "63289764ac3a1aa3b3ead12d",
            "value": 0,
            "unit": "$"
        },
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67",
        "createdAt": "2022-09-19T16:22:59.353Z",
        "updatedAt": "2022-11-04T08:45:09.614Z",
        "source": "BLIXO",
        "initial": "",
        "signatureUrl": "",
        "approvalDetail": null,
        "contractTerms": "Any changes in the specifications, quantities, schedule, and/or other aspects of the agreed to work and/or specified product that has come after the quote has been finalized are requested or approved by the signatory (you) and do not become binding upon our company (us) unless approved in writing by our company. Any such changes may result in increased charges or additional fees, and the signatory agrees to pay these increased expenses.",
        "invoice": null,
        "transactions": []
    }
}

Void a quote with this endpoint.

HTTP Request

POST /quotes/:quoteId/actions/void

Import quotes

curl "https://api-staging.blixo.com/v1/imports/importCSV/quotes" \
-u {API_KEY}: \
-X POST

The above command returns JSON structured like this:

{
    "id": "635aabad9e467f015e8470eb",
    "integration": "BLIXO",
    "companyId": "622294998bec060152bcad9c",
    "type": "quotes",
    "name": "Quotes from CSV",
    "message": "",
    "numFailed": 0,
    "numUpdated": 0,
    "numCreated": 0,
    "totalRecords": 0,
    "status": "IMPORTING",
    "importParams": null,
    "createdBy": "6222930b8bec060152bcad67",
    "updatedBy": "6222930b8bec060152bcad67",
    "createdAt": "2022-10-27T16:02:53.059Z",
    "updatedAt": "2022-10-27T16:02:53.059Z"
}

This endpoint import quotes.

HTTP Request

POST /imports/importCSV/quotes

Tasks

List all tasks

curl "https://api.blixo.com/v1/tasks" \
-u {API_KEY}:

The above command returns JSON structured like this:

{
    "data": [
        {
            "id": "635e9354a34c63015da92fc8",
            "name": "customer",
            "type": "EMAIL",
            "customerId": "635b569ec9d031e8c45b3deb",
            "assignedTo": "6222930b8bec060152bcad67",
            "dueDate": "2022-10-31T10:07:52.000Z",
            "completed": false,
            "companyId": "622294998bec060152bcad9c",
            "createdAt": "2022-10-30T15:08:04.984Z",
            "createdBy": "6222930b8bec060152bcad67",
            "updatedBy": "6222930b8bec060152bcad67"
        }
    ],
    "pagination": {
        "total": 1
    }
}

This endpoint retrieves all tasks.

HTTP Request

GET /tasks

Query Parameters

Parameter Type Description
assignedTo objectId Assigned To ID
completed boolean If set TRUE to get tasks completed else for FALSE.
page integer Current page
perPage integer Number of items per pages

Create a task

curl "https://api.blixo.com/v1/tasks" \
-u {API_KEY}: \

The above command returns JSON structured like this:

{
    "data": {
        "id": "63652176bc92e4015cd4e29e",
        "name": "customer add new task",
        "type": "REVIEW",
        "customerId": "6331629360eea3015e855e40",
        "assignedTo": "6222930b8bec060152bcad67",
        "dueDate": "2022-11-05T09:25:58.000Z",
        "completed": false,
        "companyId": "622294998bec060152bcad9c",
        "createdAt": "2022-11-04T14:28:06.986Z",
        "createdBy": "6222930b8bec060152bcad67",
        "updatedBy": "6222930b8bec060152bcad67"
    }
}

Create a new task with this endpoint.

HTTP Request

POST /tasks

Query Parameters

Parameter Type Description
name string (required) Task name
assignedTo objectId Assigned To ID
companyId objectId (required) Company ID
customerId objectId (required) Customer ID
dueDate datetime (required) Due date
type array (required)Type of task, e.g. LETTER, REVIEW, EMAIL, PHONE

Update a task

curl "https://api.blixo.com/v1/tasks/:taskId" \
-u {API_KEY}: \
-X PATCH

The above command returns JSON structured like this:

{
    "data": {
        "id": "6365259fbc92e4015cd4e4b2",