NAV
JavaScript cURL Schema

Getting Started

Environments

Currently, there are 2 publicly accessible environments for Navarik Bridge. These are differentiable by the baseURL and this is set as a variable in the collection (read below).

  1. DEMO - For learning and demonstrating capabilities of Bridge API's. Available to anyone using a test API key ().
  2. PRODUCTION - Live production environment with client's real data. Available only to authenticated users using their unique API keys.

Example code

There are JavaScript and cURL examples for each API call, which you can access via the tabs in the right sidebar. Also, for objects that you can create, there will be Schema entries available for each object creation API call.

The object creation schema use a concise JavaScript format with the following field types:

Type Description
string JSON-compatible string
int Integer
float Floating point number
boolean true or false
datetime ISO 8601 date and time, as a string
reference ID value of another entity, typically as a UUID string

All API objects are transmitted in JSON format, so any limitations of JSON types apply here.

Authentication

Most of the Navarik Bridge APIs require authentication. Identity information is provided to the APIs via a Authorization header with an API key as a Bearer token.

Please contact Navarik Support to obtain a demo API key.

How to use bearer tokens for calls

For API endpoints which a bearer token is required, please ensure you have supplied your bearer token in the header for the call to be successful.

Authorization: Bearer cfe516b8-7b6d-4e2e-a8b6-1286ea1429e4

HTTP Status Code Summary

This API documentation is organized in the following format for each call:

Error Code Meaning
200 Successful response -- Good call on GET calls.
201 Created -- Successful POST or PUT.
400 Bad Request -- Check the request to ensure it matches the schema expected.
401 Unauthorized -- No bearer token.
403 Forbidden -- Successful authorization to Navarik Bridge but unable to access the data requested.
404 Not Found -- Bad request.
500 Internal Server Error
503 Service Unavailable

Service Health

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/health'
var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api.navarik.com/bridge/v1/health',
  'headers': {
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "transport": "healthy",
    "metadataStore": "healthy",
    "dataStore": "healthy"
}

Checks the health of the API server.

GET https://api.navarik.com/bridge/v1/health

Route Parameters

None

Query Parameters

None

Headers

None

Jobs

Get job list

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/jobs?limit=2&offset=0&sort=body.refNumber:desc' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/jobs?limit=2&offset=0&sort=body.refNumber:desc',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

[
  {
    "id": "bcaa85ec-0923-4481-b83c-4ef24557cef6",
    "version_id": "4c53e536-cb55-5cf3-8ba4-dd1a622a6934",
    "parent_id": null,
    "created_by": "00000000-0000-0000-0000-000000000000",
    "created_at": "2020-04-27T20:57:18.806Z",
    "modified_by": "00000000-0000-0000-0000-000000000000",
    "modified_at": "2020-04-27T20:57:18.806Z",
    "type": "navarik.nim.job",
    "body": {
      "jobType": "SAMPLE_AND_ANALYSIS",
      "status": "ACTIVE",
      "refNumber": "TJ100501",
      "international": false,
      "eta": "2019-06-28T14:00:00.000Z",
      "etc": "2019-06-30T17:00:00.000Z",
      "notes": "this is a test job, all data is made up",
      "retain": true,
      "retainDays": 30,
      "coordinator": "User One <userone@navarik.com>",
      "inspectors": [
        {
          "role": "inspector",
          "inspector": "User Two <usertwo@navarik.com>"
        },
        {
          "role": "sampler",
          "inspector": "User Two <usertwo@navarik.com>"
        }
      ],
      "confirmedWith": "",
      "vendor": {
        "name": "Test Inspection, Inc.",
        "xref": "12345"
      },
      "client": {
        "name": "Something Something Oil corp.",
        "xref": "67890"
      },
      "inspectionObjects": [
        {
          "object": {
            "xref": "13579",
            "name": "Nameless Barge",
            "type": "BARGE",
            "imo": "0",
            "imoValid": true
          },
          "location": {
            "xref": "4567",
            "type": "PORT",
            "name": "Finnart",
            "country": "United Kingdom"
          }
        }
      ],
      "cargoes": [
        {
          "number": 1,
          "product": {
            "xref": "123",
            "type": "Crude",
            "name": "Baobab",
            "code": "AB-1234",
            "description": "Some grade",
            "sensitive": true
          },
          "volume": {
            "value": 100500,
            "uom": {
              "xref": "2",
              "name": "Liter",
              "abbr": "l"
            }
          },
          "volumeType": "net",
          "tolerance": "+/- 1 pct",
          "vcfTable": "6D"
        }
      ]
    },
    "meta": {
      "workspace": "1de0070b-9fdb-4973-9495-5d15784463db"
    },
    "schema": "cd7f4bd2-ef08-54bc-9599-ee5e5cb63a91"
  },
  {
    "id": "43e9deda-ce3a-4ece-bad0-6abc2ff226d7",
    "version_id": "1146c112-7fde-5fec-b4e9-157fac6848e0",
    "parent_id": null,
    "created_by": "00000000-0000-0000-0000-000000000000",
    "created_at": "2020-04-27T20:56:55.276Z",
    "modified_by": "00000000-0000-0000-0000-000000000000",
    "modified_at": "2020-04-27T20:56:55.276Z",
    "type": "navarik.nim.job",
    "body": {
      "jobType": "SAMPLE_AND_ANALYSIS",
      "status": "ACTIVE",
      "refNumber": "TJ100500",
      "international": false,
      "eta": "2019-06-28T14:00:00.000Z",
      "etc": "2019-06-30T17:00:00.000Z",
      "notes": "this is a test job, all data is made up",
      "retain": true,
      "retainDays": 30,
      "coordinator": "User One <userone@navarik.com>",
      "inspectors": [
        {
          "role": "inspector",
          "inspector": "User Two <usertwo@navarik.com>"
        },
        {
          "role": "sampler",
          "inspector": "User Two <usertwo@navarik.com>"
        }
      ],
      "confirmedWith": "",
      "vendor": {
        "name": "Test Inspection, Inc.",
        "xref": "12345"
      },
      "client": {
        "name": "Something Something Oil corp.",
        "xref": "67890"
      },
      "inspectionObjects": [
        {
          "object": {
            "xref": "13579",
            "name": "Nameless Barge",
            "type": "BARGE",
            "imo": "0",
            "imoValid": true
          },
          "location": {
            "xref": "4567",
            "type": "PORT",
            "name": "Finnart",
            "country": "United Kingdom"
          }
        }
      ],
      "cargoes": [
        {
          "number": 1,
          "product": {
            "xref": "123",
            "type": "Crude",
            "name": "Baobab",
            "code": "AB-1234",
            "description": "Some grade",
            "sensitive": true
          },
          "volume": {
            "value": 100500,
            "uom": {
              "xref": "2",
              "name": "Liter",
              "abbr": "l"
            }
          },
          "volumeType": "net",
          "tolerance": "+/- 1 pct",
          "vcfTable": "6D"
        }
      ]
    },
    "meta": {
      "workspace": "f958c8a4-c551-4209-86d8-15b5a6b3a205"
    },
    "schema": "cd7f4bd2-ef08-54bc-9599-ee5e5cb63a91"
  }
]

Returns a list of all jobs. Optional query parameters can be used for paginating and sorting.

GET https://api.navarik.com/bridge/v1/data/jobs

Route Parameters

None

Query Parameters

Parameter Default Description
limit null pagination, page size
offset 0 pagination, start from
sort null sort by. eg. body.refNumber:desc

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Create job

Example request

curl --request POST 'https://api.navarik.com/bridge/v1/data/jobs/' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "jobType": "SAMPLE_AND_ANALYSIS",
  "status": "ACTIVE",
  "refNumber": "TJ100500",
  "international": false,
  "eta": "2019-06-28T14:00:00.000Z",
  "etc": "2019-06-30T17:00:00.000Z",
  "notes": "this is a test job, all data is made up",
  "retain": true,
  "retainDays": 30,
  "coordinator": "User One <userone@navarik.com>",
  "inspectors": [
      {
          "role": "inspector",
          "inspector": "User Two <usertwo@navarik.com>"
      },
      {
          "role": "sampler",
          "inspector": "User Two <usertwo@navarik.com>"
      }
  ],
  "confirmedWith": "",
  "vendor": {
      "name": "Test Inspection, Inc.",
      "xref": "12345"
  },
  "client": {
      "name": "Something Something Oil corp.",
      "xref": "67890"
  },
  "inspectionObjects": [
      {
          "object": {
              "type": "BARGE",
              "name": "Nameless Barge",
              "xref": "13579",
              "imo": "0",
              "imoValid": true
          },
          "location": {
              "xref": "4567",
              "type": "PORT",
              "name": "Finnart",
              "country": "United Kingdom"
          }
      }
  ],
  "cargoes": [
      {
          "number": 1,
          "product": {
              "xref": "123",
              "type": "Crude",
              "name": "Baobab",
              "code": "AB-1234",
              "description": "Some grade",
              "sensitive": true
          },
          "volume": {
              "value": 100500,
              "uom": {
                  "xref": "2",
                  "name": "Liter",
                  "abbr": "l"
              }
          },
          "volumeType": "net",
          "tolerance": "+/- 1 pct",
          "vcfTable": "6D"
      }
  ]
}'
const request = require('request');
const options = {
  method: 'POST',
  url: 'https://api.navarik.com/bridge/v1/data/jobs',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
    "jobType": "SAMPLE_AND_ANALYSIS",
    "status": "ACTIVE",
    "refNumber": "TJ100500",
    "international": false,
    "eta": "2019-06-28T14:00:00.000Z",
    "etc": "2019-06-30T17:00:00.000Z",
    "notes": "this is a test job, all data is made up",
    "retain": true,
    "retainDays": 30,
    "coordinator": "User One <userone@navarik.com>",
    "inspectors": [
      {
        "role": "inspector",
        "inspector": "User Two <usertwo@navarik.com>"
      },
      {
        "role": "sampler",
        "inspector": "User Two <usertwo@navarik.com>"
      }
    ],
    "confirmedWith": "",
    "vendor": {
      "name": "Test Inspection, Inc.",
      "xref": "12345"
    },
    "client": {
      "name": "Something Something Oil corp.",
      "xref": "67890"
    },
    "inspectionObjects": [
      {
        "object": {
          "type": "BARGE",
          "name": "Nameless Barge",
          "xref": "13579",
          "imo": "0",
          "imoValid": true
        },
        "location": {
          "xref": "4567",
          "type": "PORT",
          "name": "Finnart",
          "country": "United Kingdom"
        }
      }
    ],
    "cargoes": [
      {
        "number": 1,
        "product": {
          "xref": "123",
          "type": "Crude",
          "name": "Baobab",
          "code": "AB-1234",
          "description": "Some grade",
          "sensitive": true
        },
        "volume": {
          "value": 100500,
          "uom": {
            "xref": "2",
            "name": "Liter",
            "abbr": "l"
          }
        },
        "volumeType": "net",
        "tolerance": "+/- 1 pct",
        "vcfTable": "6D"
      }
    ]
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
const jobSchema = {
  parent: "reference",
  jobType: "string, required",
  status: "string, required",
  refNumber: "string, required",
  international: "boolean",
  eta: "datetime",
  etc: "datetime",
  notes: "string",
  retain: "boolean, required",
  retainDays: "int",
  coordinator: "string",
  inspectors: [{
    role: "string, required",
    inspector: "string, required"
  }],
  confirmedWith: "string",
  vendor: {
    name: "string, required",
    xref: "string, required"
  },
  client: {
    name: "string, required",
    xref: "string, required"
  },
  inspectionObjects: [{
    object: {
      xref: "string, required",
      name: "string, required",
      type: "string, required",
      imo: "string, required",
      imoValid: "boolean, required"
    },
    location: {
      xref: "string, required",
      type: "string, required",
      name: "string, required",
      country: "string, required"
    }
  }],
  cargoes: [{
    number: "int, required",
    product: {
      xref: "string, required",
      type: "string, required",
      name: "string, required",
      code: "string",
      description: "string",
      sensitive: "boolean, required"
    },
    volume: {
      value: "float",
      uom: {
        xref: "string",
        name: "string",
        abbr: "string"
      }
    },
    volumeType: "string",
    tolerance: "string",
    vcfTable: "string",
  }]
}

Example response

{
    "id": "d37c5051-2507-42f2-87c6-d703c83b1894",
    "version_id": "4aaa5f79-23bc-542e-9ac1-c46d7715cd07",
    "parent_id": null,
    "created_by": "4c8b4695-45f3-5ce2-be0e-07e902e49d69",
    "created_at": "2020-09-02T22:08:04.506Z",
    "modified_by": "4c8b4695-45f3-5ce2-be0e-07e902e49d69",
    "modified_at": "2020-09-02T22:08:04.506Z",
    "type": "navarik.inspection.job",
    "body": {
        "parent": null,
        "jobType": "SAMPLE_AND_ANALYSIS",
        "status": "ACTIVE",
        "refNumber": "TJ100500",
        "international": false,
        "eta": "2019-06-28T14:00:00.000Z",
        "etc": "2019-06-30T17:00:00.000Z",
        "notes": "this is a test job, all data is made up",
        "retain": true,
        "retainDays": 30,
        "coordinator": "User One <userone@navarik.com>",
        "inspectors": [
            {
                "role": "inspector",
                "inspector": "User Two <usertwo@navarik.com>"
            },
            {
                "role": "sampler",
                "inspector": "User Two <usertwo@navarik.com>"
            }
        ],
        "confirmedWith": "",
        "vendor": {
            "name": "Test Inspection, Inc.",
            "xref": "12345"
        },
        "client": {
            "name": "Something Something Oil corp.",
            "xref": "67890"
        },
        "inspectionObjects": [
            {
                "object": {
                    "xref": "13579",
                    "name": "Nameless Barge",
                    "type": "BARGE",
                    "imo": "0",
                    "imoValid": true
                },
                "location": {
                    "xref": "4567",
                    "type": "PORT",
                    "name": "Finnart",
                    "country": "United Kingdom"
                }
            }
        ],
        "cargoes": [
            {
                "number": 1,
                "product": {
                    "xref": "123",
                    "type": "Crude",
                    "name": "Baobab",
                    "code": "AB-1234",
                    "description": "Some grade",
                    "sensitive": true
                },
                "volume": {
                    "value": 100500,
                    "uom": {
                        "xref": "2",
                        "name": "Liter",
                        "abbr": "l"
                    }
                },
                "volumeType": "net",
                "tolerance": "+/- 1 pct",
                "vcfTable": "6D"
            }
        ]
    },
    "meta": {},
    "schema": "a31cd77c-bb7e-5367-b22b-75f74db9a04c"
}

Creates a new job and upon success returns that same data structure with a unique id field added that can be used to reference the job in subsequent requests.

POST https://api.navarik.com/bridge/v1/data/jobs

Route Parameters

None

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}
Content-Type application/json

Get specific job

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "d37c5051-2507-42f2-87c6-d703c83b1894",
    "version_id": "5ae762fd-5f82-56fa-a139-c3cd35167bfb",
    "parent_id": "634a4140-dee8-5536-aff8-dabeb2eb2c42",
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T18:22:19.913Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T18:38:18.636Z",
    "type": "navarik.inspection.job",
    "body": {
        "parent": null,
        "jobType": "SAMPLE_AND_ANALYSIS",
        "status": "ON HOLD",
        "refNumber": "TJ100500",
        "international": false,
        "eta": "2019-06-28T14:00:00.000Z",
        "etc": "2019-06-30T17:00:00.000Z",
        "notes": "Put on hold until further notice - PATCH test",
        "retain": true,
        "retainDays": 30,
        "coordinator": "User One <userone@navarik.com>",
        "inspectors": [
            {
                "role": "inspector",
                "inspector": "User Two <usertwo@navarik.com>"
            },
            {
                "role": "sampler",
                "inspector": "User Two <usertwo@navarik.com>"
            }
        ],
        "confirmedWith": "",
        "vendor": {
            "name": "Test Inspection, Inc.",
            "xref": "12345"
        },
        "client": {
            "name": "Something Something Oil corp.",
            "xref": "67890"
        },
        "inspectionObjects": [
            {
                "object": {
                    "xref": "13579",
                    "name": "Nameless Barge",
                    "type": "BARGE",
                    "imo": "0",
                    "imoValid": true
                },
                "location": {
                    "xref": "4567",
                    "type": "PORT",
                    "name": "Finnart",
                    "country": "United Kingdom"
                }
            }
        ],
        "cargoes": [
            {
                "number": 1,
                "product": {
                    "xref": "123",
                    "type": "Crude",
                    "name": "Baobab",
                    "code": "AB-1234",
                    "description": "Some grade",
                    "sensitive": true
                },
                "volume": {
                    "value": 100500,
                    "uom": {
                        "xref": "2",
                        "name": "Liter",
                        "abbr": "l"
                    }
                },
                "volumeType": "net",
                "tolerance": "+/- 1 pct",
                "vcfTable": "6D"
            }
        ]
    },
    "meta": {},
    "schema": "a31cd77c-bb7e-5367-b22b-75f74db9a04c"
}

Gets a single job specified by the unique ID for that job. This id field can be found in the response received when creating or listing jobs.

GET https://api.navarik.com/bridge/v1/data/jobs/<id>

Route Parameters

Parameter Default Description
id null job id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Update job

Example request

curl --request PATCH 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '  {
    "body": {
        "status": "PENDING",
        "notes": "Put on hold until further notice - PATCH test"
    }
  }'
const request = require('request');
const options = {
  method: 'PATCH',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
    body: {
      "status": "PENDING",
      "notes": "Put on hold until further notice - PATCH test"
    }
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "d37c5051-2507-42f2-87c6-d703c83b1894",
    "version_id": "634a4140-dee8-5536-aff8-dabeb2eb2c42",
    "parent_id": "1c086f4a-30c2-5097-ab60-2637d12bf7fc",
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T18:22:19.913Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T18:37:28.083Z",
    "type": "navarik.inspection.job",
    "body": {
        "parent": null,
        "jobType": "SAMPLE_AND_ANALYSIS",
        "status": "PENDING",
        "refNumber": "TJ100500",
        "international": false,
        "eta": "2019-06-28T14:00:00.000Z",
        "etc": "2019-06-30T17:00:00.000Z",
        "notes": "Put on hold until further notice - PATCH test",
        "retain": true,
        "retainDays": 30,
        "coordinator": "User One <userone@navarik.com>",
        "inspectors": [
            {
                "role": "inspector",
                "inspector": "User Two <usertwo@navarik.com>"
            },
            {
                "role": "sampler",
                "inspector": "User Two <usertwo@navarik.com>"
            }
        ],
        "confirmedWith": "",
        "vendor": {
            "name": "Test Inspection, Inc.",
            "xref": "12345"
        },
        "client": {
            "name": "Something Something Oil corp.",
            "xref": "67890"
        },
        "inspectionObjects": [
            {
                "object": {
                    "xref": "13579",
                    "name": "Nameless Barge",
                    "type": "BARGE",
                    "imo": "0",
                    "imoValid": true
                },
                "location": {
                    "xref": "4567",
                    "type": "PORT",
                    "name": "Finnart",
                    "country": "United Kingdom"
                }
            }
        ],
        "cargoes": [
            {
                "number": 1,
                "product": {
                    "xref": "123",
                    "type": "Crude",
                    "name": "Baobab",
                    "code": "AB-1234",
                    "description": "Some grade",
                    "sensitive": true
                },
                "volume": {
                    "value": 100500,
                    "uom": {
                        "xref": "2",
                        "name": "Liter",
                        "abbr": "l"
                    }
                },
                "volumeType": "net",
                "tolerance": "+/- 1 pct",
                "vcfTable": "6D"
            }
        ]
    },
    "meta": {},
    "schema": "a31cd77c-bb7e-5367-b22b-75f74db9a04c"
}

Updates a job specified by the unique ID for that job. This id field can be found in the response received when creating or listing jobs.

PATCH https://api.navarik.com/bridge/v1/data/jobs/<id>

Route Parameters

Parameter Default Description
id null job id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}
Content-Type application/json

Documents

Get document list

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents?limit=2&offset=0&sort=type:asc',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

[
    {
        "id": "ed86ae29-91f9-4763-9357-2dc3df7eab86",
        "version_id": "af5a6137-aa69-5e10-a916-c4ba78bd137a",
        "parent_id": null,
        "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "created_at": "2020-08-26T21:54:03.682Z",
        "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "modified_at": "2020-08-26T21:54:03.682Z",
        "type": "navarik.inspection.timeLog",
        "body": {
            "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
            "pumpingRate": "0.07",
            "events": [
                {
                    "name": "Connect Hose",
                    "date": "2020-08-11",
                    "time": "07:51:19.956Z",
                    "remark": "Successful"
                },
                {
                    "name": "Discharge Cargo",
                    "date": "2020-08-12",
                    "time": "09:53:20.711Z",
                    "remark": null
                }
            ]
        },
        "meta": {},
        "schema": "4bac2fad-51b4-5956-a1a6-9c118e572ebe"
    }
]

Returns a list of all inspection documents of a job given that job's unique id. Optional query parameters can be used for paginating and sorting.

GET https://api.navarik.com/bridge/v1/data/jobs/<jobId>/documents

Route Parameters

Parameter Default Description
jobId null job id (required)

Query Parameters

Parameter Default Description
limit null pagination, page size
offset 0 pagination, start from
sort null sort by. eg. type:asc

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Create document

Example request

curl --request POST 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "type": "navarik.inspection.timeLog",
  "body": {
    "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
    "pumpingRate": "0.07",
    "events": [
      {"name": "Connect Hose",
      "date": "2020-08-11",
      "time": "07:51:19.956Z",
      "remark": "Successful"},
      {"name": "Discharge Cargo",
      "date": "2020-08-12",
      "time": "09:53:20.711Z",
      "remake": "No Remark"}
    ]
  },
  "schema": {
    "fields": {
    "parent": "reference, required",
    "pumpingRate": "string",
    "events": [{
      "name": "string",
      "date": "string",
      "time": "string",
      "remark": "string"
    }]
  }
  }
}'
const request = require('request');
const options = {
  method: 'POST',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
    "type": "navarik.inspection.timeLog",
    "body": {
      "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
      "pumpingRate": "0.07",
      "events": [
        {
          "name": "Connect Hose",
          "date": "2020-08-11",
          "time": "07:51:19.956Z",
          "remark": "Successful"
        }, {
          "name": "Discharge Cargo",
          "date": "2020-08-12",
          "time": "09:53:20.711Z",
          "remake": "No Remark"
        }
      ]
    },
    "schema": {
      "fields": {
        "parent": "reference, required",
        "pumpingRate": "string",
        "events": [
          {
            "name": "string",
            "date": "string",
            "time": "string",
            "remark": "string"
          }
        ]
      }
    }
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "ed86ae29-91f9-4763-9357-2dc3df7eab86",
    "version_id": "af5a6137-aa69-5e10-a916-c4ba78bd137a",
    "parent_id": null,
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T21:54:03.682Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T21:54:03.682Z",
    "type": "navarik.inspection.timeLog",
    "body": {
        "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
        "pumpingRate": "0.07",
        "events": [
            {
                "name": "Connect Hose",
                "date": "2020-08-11",
                "time": "07:51:19.956Z",
                "remark": "Successful"
            },
            {
                "name": "Discharge Cargo",
                "date": "2020-08-12",
                "time": "09:53:20.711Z",
                "remark": null
            }
        ]
    },
    "meta": {},
    "schema": "4bac2fad-51b4-5956-a1a6-9c118e572ebe"
}

Creates a supporting inspection document for a job specified by that job's unique id.

POST https://api.navarik.com/bridge/v1/data/jobs/<jobId>/documents

Route Parameters

Parameter Default Description
jobId null job id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Get specific document

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents/ed86ae29-91f9-4763-9357-2dc3df7eab86' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents/ed86ae29-91f9-4763-9357-2dc3df7eab86',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "ed86ae29-91f9-4763-9357-2dc3df7eab86",
    "version_id": "af5a6137-aa69-5e10-a916-c4ba78bd137a",
    "parent_id": null,
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T21:54:03.682Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T21:54:03.682Z",
    "type": "navarik.inspection.timeLog",
    "body": {
        "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
        "pumpingRate": "0.07",
        "events": [
            {
                "name": "Connect Hose",
                "date": "2020-08-11",
                "time": "07:51:19.956Z",
                "remark": "Successful"
            },
            {
                "name": "Discharge Cargo",
                "date": "2020-08-12",
                "time": "09:53:20.711Z",
                "remark": null
            }
        ]
    },
    "meta": {},
    "schema": "4bac2fad-51b4-5956-a1a6-9c118e572ebe"
}

Gets a single inspection document given the document's id and the id of the job it belongs to.

GET https://api.navarik.com/bridge/v1/data/jobs/<jobId>/documents/<docId>

Route Parameters

Parameter Default Description
jobId null job id (required)
docId null document id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Update document

Example request

curl --request PATCH 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents/ed86ae29-91f9-4763-9357-2dc3df7eab86' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "body": {
    "pumpingRate": "0.8"
  }
}'
const request = require('request');
const options = {
  method: 'PATCH',
  url: 'https://api.navarik.com/bridge/v1/data/jobs/d37c5051-2507-42f2-87c6-d703c83b1894/documents/ed86ae29-91f9-4763-9357-2dc3df7eab86',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
    "body": {
      "pumpingRate": "0.8"
    }
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "ed86ae29-91f9-4763-9357-2dc3df7eab86",
    "version_id": "c7a24d19-c348-52e2-a44c-90b54f6de88d",
    "parent_id": "af5a6137-aa69-5e10-a916-c4ba78bd137a",
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T21:54:03.682Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T22:35:32.947Z",
    "type": "navarik.inspection.timeLog",
    "body": {
        "parent": "d37c5051-2507-42f2-87c6-d703c83b1894",
        "pumpingRate": "0.8",
        "events": [
            {
                "name": "Connect Hose",
                "date": "2020-08-11",
                "time": "07:51:19.956Z",
                "remark": "Successful"
            },
            {
                "name": "Discharge Cargo",
                "date": "2020-08-12",
                "time": "09:53:20.711Z",
                "remark": null
            }
        ]
    },
    "meta": {},
    "schema": "4bac2fad-51b4-5956-a1a6-9c118e572ebe"
}

Updates an inspection document given the document's id and the id of the job it belongs to.

PATCH https://api.navarik.com/bridge/v1/data/jobs/<jobId>/documents/<docId>

Route Parameters

Parameter Default Description
jobId null job id (required)
docId null document id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}
Content-Type application/json

Invoices

Get invoice list

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/invoices' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/invoices',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

[
    {
        "id": "27a091a4-6ae2-411d-85d9-cdfc67f339a5",
        "version_id": "868999ae-6edb-5637-938a-afbea5ad1a7f",
        "parent_id": null,
        "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "created_at": "2020-08-11T07:29:59.975Z",
        "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "modified_at": "2020-08-11T07:29:59.975Z",
        "type": "navarik.invoice",
        "body": {
            "refNumber": "TI100300",
            "status": "PENDING",
            "baseDocument": null,
            "issueDate": "2019-07-20T17:00:00.000Z",
            "dueDate": "2019-08-31T17:00:00.000Z",
            "description": "Some very important information that nobody reads",
            "customer": {
                "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
                "address": null,
                "email": null,
                "name": "Something Something Oil corp.",
                "phone": null
            },
            "lines": [
                {
                    "amount": 100500.5,
                    "currency": "CAD",
                    "description": "Such doge",
                    "price": 100500.5,
                    "quantity": 1,
                    "taxes": [
                        {
                            "name": "WOW",
                            "rate": 0.5
                        }
                    ]
                },
                {
                    "amount": 100500.5,
                    "currency": "CAD",
                    "description": "Many Wow",
                    "price": 100500.5,
                    "quantity": 1,
                    "taxes": [
                        {
                            "name": "WOW",
                            "rate": 0.5
                        }
                    ]
                }
            ],
            "currency": "CAD",
            "subtotal": 201001,
            "tax": 100500.5,
            "total": 301500.5,
            "totalTax": [
                {
                    "name": "WOW",
                    "rate": 0.5
                }
            ],
            "credit": false,
            "amountDue": 301500.5,
            "amountPaid": 0,
            "amountRemaining": 301500.5
        },
        "meta": {
            "sc": "c389352c-54d8-400e-95e8-597b9a4410e8"
        },
        "schema": "e7b0b07b-db20-5c65-a1f3-a158f9c0b507"
    },
    {
        "id": "b0663db1-e4cf-43e7-aa01-935f9ca47825",
        "version_id": "49001eea-b416-5d5a-aa71-d5cef20bf345",
        "parent_id": null,
        "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "created_at": "2020-08-11T05:35:54.501Z",
        "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
        "modified_at": "2020-08-11T05:35:54.501Z",
        "type": "navarik.invoice",
        "body": {
            "refNumber": "TI100301",
            "status": "PAID",
            "baseDocument": "aa5589a3-cddd-416c-89d6-ea29851e4762",
            "issueDate": "2019-03-20T17:00:00.000Z",
            "dueDate": "2019-04-28T17:00:00.000Z",
            "description": "Some very important information that nobody reads",
            "customer": {
                "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
                "address": null,
                "email": null,
                "name": "Something Something Oil corp.",
                "phone": null
            },
            "lines": [
                {
                    "amount": 100500.5,
                    "currency": "CAD",
                    "description": "Such doge",
                    "price": 100500.5,
                    "quantity": 1,
                    "taxes": [
                        {
                            "name": "WOW",
                            "rate": 0.5
                        }
                    ]
                },
                {
                    "amount": 100500.5,
                    "currency": "CAD",
                    "description": "Many Wow",
                    "price": 100500.5,
                    "quantity": 1,
                    "taxes": [
                        {
                            "name": "WOW",
                            "rate": 0.5
                        }
                    ]
                }
            ],
            "currency": "CAD",
            "subtotal": 201001,
            "tax": 100500.5,
            "total": 301500.5,
            "totalTax": [
                {
                    "name": "WOW",
                    "rate": 0.5
                }
            ],
            "credit": false,
            "amountDue": 301500.5,
            "amountPaid": 301500.5,
            "amountRemaining": 0
        },
        "meta": {
            "sc": "23790864-b919-4314-a471-7133f30fd774"
        },
        "schema": "e7b0b07b-db20-5c65-a1f3-a158f9c0b507"
    }
]

Returns a list of all invoices. Optional query parameters can be used for paginating and sorting.

GET https://api.navarik.com/bridge/v1/data/invoices

Route Parameters

None

Query Parameters

Parameter Default Description
limit null pagination, page size
offset 0 pagination, start from
sort null sort by. eg. body.refNumber:desc

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Create invoice

Example request

curl --request POST 'https://api.navarik.com/bridge/v1/data/invoices/' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "refNumber": "TI100300",
  "status": "PENDING",
  "issueDate": "2019-07-20T17:00:00.000Z",
  "dueDate": "2019-08-31T17:00:00.000Z",
  "baseDocument": null,
  "description": "Some very important information that nobody reads",
  "customer": {
    "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
    "name": "Something Something Oil corp.",
    "address": null,
    "phone": null,
    "email": null
  },
  "lines": [
    {
        "amount": 100500.50,
        "currency": "CAD",
        "description": "Such doge",
        "price": 100500.50,
        "quantity": 1,
        "taxes": [
        {
          "name": "WOW",
          "rate": 0.5
        }
      ]
    },
    {
      "amount": 100500.50,
      "currency": "CAD",
      "description": "Many Wow",
      "price": 100500.50,
      "quantity": 1,
      "taxes": [
        {
          "name": "WOW",
          "rate": 0.5
        }
      ]
    }
  ],
  "currency": "CAD",
  "subtotal": 201001,
  "tax": 100500.5,
  "total": 301500.5,
  "totalTax": [
    {
      "name": "WOW",
      "rate": 0.5
    }
  ],
  "credit": false,
  "amountDue": 301500.5,
  "amountPaid": 0,
  "amountRemaining": 301500.5
}'
const request = require('request');
const options = {
  method: 'POST',
  url: 'https://api.navarik.com/bridge/v1/data/invoices',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
  "refNumber": "TI100300",
  "status": "PENDING",
  "issueDate": "2019-07-20T17:00:00.000Z",
  "dueDate": "2019-08-31T17:00:00.000Z",
  "baseDocument": null,
  "description": "Some very important information that nobody reads",
  "customer": {
    "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
    "name": "Something Something Oil corp.",
    "address": null,
    "phone": null,
    "email": null
  },
  "lines": [
    {
      "amount": 100500.50,
      "currency": "CAD",
      "description": "Such doge",
      "price": 100500.50,
      "quantity": 1,
      "taxes": [
        {
          "name": "WOW",
          "rate": 0.5
        }
      ]
    },
    {
      "amount": 100500.50,
      "currency": "CAD",
      "description": "Many Wow",
      "price": 100500.50,
      "quantity": 1,
      "taxes": [
        {
          "name": "WOW",
          "rate": 0.5
        }
      ]
    }
  ],
  "currency": "CAD",
  "subtotal": 201001,
  "tax": 100500.5,
  "total": 301500.5,
  "totalTax": [
    {
      "name": "WOW",
      "rate": 0.5
    }
  ],
  "credit": false,
  "amountDue": 301500.5,
  "amountPaid": 0,
  "amountRemaining": 301500.5
}


};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "27a091a4-6ae2-411d-85d9-cdfc67f339a5",
    "version_id": "868999ae-6edb-5637-938a-afbea5ad1a7f",
    "parent_id": null,
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-11T07:29:59.975Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-11T07:29:59.975Z",
    "type": "navarik.invoice",
    "body": {
        "refNumber": "TI100300",
        "status": "PENDING",
        "baseDocument": null,
        "issueDate": "2019-07-20T17:00:00.000Z",
        "dueDate": "2019-08-31T17:00:00.000Z",
        "description": "Some very important information that nobody reads",
        "customer": {
            "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
            "address": null,
            "email": null,
            "name": "Something Something Oil corp.",
            "phone": null
        },
        "lines": [
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Such doge",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            },
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Many Wow",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            }
        ],
        "currency": "CAD",
        "subtotal": 201001,
        "tax": 100500.5,
        "total": 301500.5,
        "totalTax": [
            {
                "name": "WOW",
                "rate": 0.5
            }
        ],
        "credit": false,
        "amountDue": 301500.5,
        "amountPaid": 0,
        "amountRemaining": 301500.5
    },
    "meta": {
        "sc": "c389352c-54d8-400e-95e8-597b9a4410e8"
    },
    "schema": "e7b0b07b-db20-5c65-a1f3-a158f9c0b507"
}

Creates an invoice and upon success returns that same data structure with a unique id field added that can be used to reference the job in subsequent requests.

POST https://api.navarik.com/bridge/v1/data/invoices

Route Parameters

None

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}
Content-Type application/json

Get specific invoice

Example request

curl --request GET 'https://api.navarik.com/bridge/v1/data/invoices/1d2e1b7e-12cc-45b8-97c1-54fead899d18' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey'
const request = require('request');
const options = {
  method: 'GET',
  url: 'https://api.navarik.com/bridge/v1/data/invoices/1d2e1b7e-12cc-45b8-97c1-54fead899d18',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "1d2e1b7e-12cc-45b8-97c1-54fead899d18",
    "version_id": "e124e34c-48d3-5e28-b9c4-17f445afa27e",
    "parent_id": null,
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T19:27:20.444Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T19:27:20.444Z",
    "type": "navarik.invoice",
    "body": {
        "refNumber": "TI100300",
        "status": "PENDING",
        "baseDocument": null,
        "issueDate": "2019-07-20T17:00:00.000Z",
        "dueDate": "2019-08-31T17:00:00.000Z",
        "description": "Some very important information that nobody reads",
        "customer": {
            "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
            "address": null,
            "email": null,
            "name": "Something Something Oil corp.",
            "phone": null
        },
        "lines": [
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Such doge",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            },
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Many Wow",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            }
        ],
        "currency": "CAD",
        "subtotal": 201001,
        "tax": 100500.5,
        "total": 301500.5,
        "totalTax": [
            {
                "name": "WOW",
                "rate": 0.5
            }
        ],
        "credit": false,
        "amountDue": 301500.5,
        "amountPaid": 0,
        "amountRemaining": 301500.5
    },
    "meta": {},
    "schema": "e7b0b07b-db20-5c65-a1f3-a158f9c0b507"
}

Gets a single invoice specified by the unique ID for that job. This id field can be found in the response received when creating or listing jobs.

GET https://api.navarik.com/bridge/v1/data/invoices/<id>

Route Parameters

Parameter Default Description
id null invoice id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}

Update invoice

Example request

curl --request PATCH 'https://api.navarik.com/bridge/v1/data/invoices/1d2e1b7e-12cc-45b8-97c1-54fead899d18' \
--header 'Accept-Version: 1.0' \
--header 'Authorization: Bearer yourApiKey' \
--header 'Content-Type: application/json' \
--data-raw '{
  "body": {
    "status": "PAID",
    "amountPaid": 301500.5,
    "amountRemaining": 0
  }
}'
const request = require('request');
const options = {
  method: 'PATCH',
  url: 'https://api.navarik.com/bridge/v1/data/invoices/1d2e1b7e-12cc-45b8-97c1-54fead899d18',
  headers: {
    'Accept-Version': '1.0',
    'Authorization': 'Bearer yourApiKey',
    'Content-Type': 'application/json',
  },
  json: {
    "body": {
      "status":"PAID",
      "amountPaid":301500.5,
      "amountRemaining":0
    }
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Example response

{
    "id": "1d2e1b7e-12cc-45b8-97c1-54fead899d18",
    "version_id": "074dd4df-faf3-518e-854a-02dcd24208ec",
    "parent_id": "e124e34c-48d3-5e28-b9c4-17f445afa27e",
    "created_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "created_at": "2020-08-26T19:27:20.444Z",
    "modified_by": "17b704ab-8b16-5517-bd38-11714f3aab85",
    "modified_at": "2020-08-26T20:15:28.987Z",
    "type": "navarik.invoice",
    "body": {
        "refNumber": "TI100300",
        "status": "PAID",
        "baseDocument": null,
        "issueDate": "2019-07-20T17:00:00.000Z",
        "dueDate": "2019-08-31T17:00:00.000Z",
        "description": "Some very important information that nobody reads",
        "customer": {
            "id": "aa5589a3-cddd-416c-89d6-ea29851e4762",
            "address": null,
            "email": null,
            "name": "Something Something Oil corp.",
            "phone": null
        },
        "lines": [
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Such doge",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            },
            {
                "amount": 100500.5,
                "currency": "CAD",
                "description": "Many Wow",
                "price": 100500.5,
                "quantity": 1,
                "taxes": [
                    {
                        "name": "WOW",
                        "rate": 0.5
                    }
                ]
            }
        ],
        "currency": "CAD",
        "subtotal": 201001,
        "tax": 100500.5,
        "total": 301500.5,
        "totalTax": [
            {
                "name": "WOW",
                "rate": 0.5
            }
        ],
        "credit": false,
        "amountDue": 301500.5,
        "amountPaid": 301500.5,
        "amountRemaining": 0
    },
    "meta": {},
    "schema": "e7b0b07b-db20-5c65-a1f3-a158f9c0b507"
}

Updates an invoice

PATCH https://api.navarik.com/bridge/v1/data/invoices/<id>

Parameters

Parameter Default Description
id null invoice id (required)

Query Parameters

None

Headers

Key Value
Accept-Version 1.0
Authorization Bearer {{accessToken}}
Content-Type application/json