{ "info": { "description": "Upwell is Accounts Receivable automation software for the logistics industry. We serve freight brokers, carriers, factors, and anyone who needs to get transportation invoices paid.\n\nLearn more at:\n\n- [Upwell.com](https://upwell.com)", "title": "Upwell REST API", "version": "3.30.2", "termsOfService": "https://upwell.com/legal", "contact": { "name": "Upwell", "url": "https://upwell.com", "email": "contact@upwell.com" } }, "paths": { "/api/rest/carrier_payment_line_items": { "get": { "summary": "Get Many Carrier Payment Line Items", "description": "Query a list of carrier payment line items", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/carrier_payment_line_items" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Carrier Payment Line Item", "description": "Create a new carrier payment line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/BillPaymentLineItemsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrierPaymentLineItem": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" } } } } }, "description": "Responses for POST /api/rest/carrier_payment_line_items" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_payment_line_items/{id}": { "get": { "summary": "Get One Carrier Payment Line Item", "description": "Get a carrier payment line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierPaymentLineItem": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" } } } } }, "description": "Responses for GET /api/rest/carrier_payment_line_items/{id}" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Carrier Payment Line Item", "description": "Update a carrier payment line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/BillPaymentLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCarrierPaymentLineItem": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/carrier_payment_line_items/{id}" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Carrier Payment Line Item", "description": "Delete a carrier payment line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCarrierPaymentLineItem": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/carrier_payment_line_items/{id}" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendors": { "post": { "summary": "Create One Vendor", "description": "Create a new vendor", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/VendorsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createVendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" } } } } }, "description": "Responses for POST /api/rest/vendors" } }, "tags": [ "Vendors" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendors/search": { "post": { "summary": "Search Vendors", "description": "Search for vendors based on Source System and Source System ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendors": { "items": { "description": "Vendors", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/vendors/search" } }, "tags": [ "Vendors" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendors/{id}": { "get": { "summary": "Get One Vendor", "description": "Get a vendor by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" } } } } }, "description": "Responses for GET /api/rest/vendors/{id}" } }, "tags": [ "Vendors" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Vendor", "description": "Delete a vendor by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteVendor": { "description": "Vendors", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Vendors", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/vendors/{id}" } }, "tags": [ "Vendors" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Vendor", "description": "Update a vendor by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/VendorsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateVendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/vendors/{id}" } }, "tags": [ "Vendors" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-carrier-payment-line-items": { "post": { "summary": "Create Many Carrier Payment Line Items", "description": "Create multiple carrier payment line items at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/BillPaymentLineItemsInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrierPaymentLineItems": { "description": "response of any mutation on the table \"bill_payment_line_items\"", "nullable": true, "properties": { "returning": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "BillPaymentLineItemsMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-carrier-payment-line-items" } }, "tags": [ "Carrier Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoice_line_items": { "post": { "summary": "Create One Invoice Line Item", "description": "Create a new invoice line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/InvoiceLineItemsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createInvoiceLineItem": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" } } } } }, "description": "Responses for POST /api/rest/invoice_line_items" } }, "tags": [ "Invoice Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoice_line_items/{id}": { "delete": { "summary": "Delete One Invoice Line Item", "description": "Delete an invoice line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteInvoiceLineItem": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceLineItems", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/invoice_line_items/{id}" } }, "tags": [ "Invoice Line Items" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Invoice Line Item", "description": "Update an invoice line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/InvoiceLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateInvoiceLineItem": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/invoice_line_items/{id}" } }, "tags": [ "Invoice Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoices": { "get": { "summary": "Get Many Carrier Invoices", "description": "Query a list of carrier invoices", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierInvoices": { "items": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": false, "properties": { "balance": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoiceLineItems": { "items": { "description": "columns and relationships of \"carrier_invoice_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoices", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/carrier_invoices" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Carrier Invoice", "description": "Create a new carrier invoice", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CarrierInvoicesInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": true, "properties": { "balance": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoiceLineItems": { "items": { "description": "columns and relationships of \"carrier_invoice_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoices", "type": "object" } } } } }, "description": "Responses for POST /api/rest/carrier_invoices" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoices/{id}": { "get": { "summary": "Get One Carrier Invoice", "description": "Get a carrier invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": true, "properties": { "balance": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoiceLineItems": { "items": { "description": "columns and relationships of \"carrier_invoice_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoices", "type": "object" } } } } }, "description": "Responses for GET /api/rest/carrier_invoices/{id}" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Carrier Invoice", "description": "Update a carrier invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/CarrierInvoicesSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCarrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": true, "properties": { "balance": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoiceLineItems": { "items": { "description": "columns and relationships of \"carrier_invoice_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoices", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/carrier_invoices/{id}" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Carrier Invoice", "description": "Delete a carrier invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCarrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": true, "properties": { "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CarrierInvoices", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/carrier_invoices/{id}" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoices/{carrierInvoiceId}/documents": { "get": { "summary": "Get Many Carrier Invoice Documents", "description": "Query a list of carrier invoice documents", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"carrierInvoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "carrierInvoiceId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceDocumentsByCarrierInvoiceId": { "items": { "nullable": false, "properties": { "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/DateTime" }, "documentId": { "nullable": false, "title": "String", "type": "string" }, "filename": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "isPod": { "nullable": true, "title": "Boolean", "type": "boolean" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/DateTime" }, "uploadToTms": { "nullable": false, "title": "Boolean", "type": "boolean" }, "url": { "nullable": false, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": false, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": false, "title": "Boolean", "type": "boolean" } }, "title": "CarrierInvoiceDocument", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/carrier_invoices/{carrierInvoiceId}/documents" } }, "tags": [ "Carrier Invoice Documents" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create Carrier Invoice Document", "description": "Create a new carrier invoice document", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"carrierInvoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "carrierInvoiceId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/CreateCarrierInvoiceDocumentInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrierInvoiceDocument": { "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CarrierInvoiceDocument", "type": "object" } } } } }, "description": "Responses for POST /api/rest/carrier_invoices/{carrierInvoiceId}/documents" } }, "tags": [ "Carrier Invoice Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoices/{carrierInvoiceId}/documents/{id}": { "delete": { "summary": "Delete Carrier Invoice Document", "description": "Delete a carrier invoice document by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"carrierInvoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "carrierInvoiceId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteFileAssociations": { "description": "response of any mutation on the table \"file_associations\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "Relationships for files", "nullable": false, "properties": { "associationId": { "nullable": false, "title": "String", "type": "string" }, "fileId": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "FileAssociations", "type": "object" }, "nullable": false, "type": "array" } }, "title": "FileAssociationsMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/carrier_invoices/{carrierInvoiceId}/documents/{id}" } }, "tags": [ "Carrier Invoice Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoices/{carrierInvoiceId}/approve": { "post": { "summary": "Approve One Carrier Invoice", "description": "Approve a carrier invoice by ID", "parameters": [ { "description": "_\"carrierInvoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "carrierInvoiceId", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "overrideExceptions", "schema": { "default": false, "type": "boolean" }, "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "overrideExceptions": { "default": false, "nullable": true, "title": "Boolean", "type": "boolean" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "approveCarrierInvoice": { "nullable": false, "properties": { "error": { "nullable": true, "properties": { "code": { "nullable": false, "title": "String", "type": "string" }, "message": { "nullable": false, "title": "String", "type": "string" } }, "title": "CarrierInvoiceErrorResponse", "type": "object" }, "exceptions": { "items": { "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "ownerId": { "nullable": false, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/ExceptionStatusEnum" }, "type": { "$ref": "#/components/schemas/ExceptionTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoiceException", "type": "object" }, "nullable": false, "type": "array" }, "success": { "nullable": false, "title": "Boolean", "type": "boolean" } }, "title": "CarrierInvoiceResponse", "type": "object" } }, "type": "object" } } }, "description": "Successful response" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/generate-upload-presigned-url": { "post": { "summary": "Generate Upload Presigned Url", "description": "Generate a presigned URL for direct S3 file upload.\n\n**Integration notes:**\n- If you provide `sourceSystem` you must also provide `sourceSystemId` (and vice versa) — the `documents_source_system_pair_nullity_chk` constraint requires both or neither.\n- On the subsequent `PUT` to the returned `uploadUrl`, prefer an `ArrayBuffer` body over `Blob`. Wrapping in a `Blob` with an explicit type can cause some Node fetch implementations to add headers that aren't in `X-Amz-SignedHeaders`, breaking the SigV4 signature.\n\nSee [Integration patterns](/integration-patterns#document-upload-two-step-presigned-url).", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/GenerateUploadUrlInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "generateUploadPresignedUrl": { "nullable": false, "properties": { "documentId": { "nullable": true, "title": "String", "type": "string" }, "uploadUrl": { "nullable": false, "title": "String", "type": "string" } }, "title": "UploadPresignedUrlResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/generate-upload-presigned-url" } }, "tags": [ "Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/addresses": { "get": { "summary": "Get Many Addresses", "description": "Query a list of addresses", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/addresses" } }, "tags": [ "Addresses" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Address", "description": "Create a new address", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/AddressesInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" } } } } }, "description": "Responses for POST /api/rest/addresses" } }, "tags": [ "Addresses" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/addresses/{id}": { "get": { "summary": "Get One Address", "description": "Get an address by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" } } } } }, "description": "Responses for GET /api/rest/addresses/{id}" } }, "tags": [ "Addresses" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Address", "description": "Update an address by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/AddressesSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/addresses/{id}" } }, "tags": [ "Addresses" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Address", "description": "Delete an address by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/addresses/{id}" } }, "tags": [ "Addresses" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carriers": { "get": { "summary": "Get Many Carriers", "description": "Query a list of carriers", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carriers": { "items": { "description": "columns and relationships of \"carriers\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/carriers" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Carrier By Source System Id", "description": "Update a carrier by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CarriersSetInput" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCarrier": { "description": "response of any mutation on the table \"carriers\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"carriers\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CarriersMutationResponse", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/carriers" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Carrier", "description": "Create a new carrier", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CarriersInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" } } } } }, "description": "Responses for POST /api/rest/carriers" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Carrier By Source System Id", "description": "Delete a carrier by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCarrier": { "description": "response of any mutation on the table \"carriers\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"carriers\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Carriers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CarriersMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/carriers" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carriers/search": { "post": { "summary": "Search Carriers", "description": "Search for carriers based on specified criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "CarriersOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"carriers\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "CarriersBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "CarriersBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "CarriersBoolExp (simplified)" }, "nullable": true, "type": "array" }, "address": { "type": "object", "description": "AddressesBoolExp (simplified)" }, "addressId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "addressesLastUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "aljexId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "billingAddressId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "bills": { "type": "object", "description": "BillsBoolExp (simplified)" }, "billsAggregate": { "type": "object", "description": "BillsAggregateBoolExp (simplified)" }, "cargoInsuranceExpireDate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "carrierIntegrationsMappings": { "type": "object", "description": "CarrierIntegrationsMappingBoolExp (simplified)" }, "carrierIntegrationsMappingsAggregate": { "type": "object", "description": "CarrierIntegrationsMappingAggregateBoolExp (simplified)" }, "carrierInvoices": { "type": "object", "description": "CarrierInvoicesBoolExp (simplified)" }, "carrierInvoicesAggregate": { "type": "object", "description": "CarrierInvoicesAggregateBoolExp (simplified)" }, "computedNameLowercase": { "type": "object", "description": "StringComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "dotNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "email": { "type": "object", "description": "StringComparisonExp (simplified)" }, "freezePay": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "generalLiabilityInsuranceExpireDate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "isOwnerOperator": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "isQuickpay": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "liabilityInsuranceExpireDate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "mcNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "name": { "type": "object", "description": "StringComparisonExp (simplified)" }, "payToAddress": { "type": "object", "description": "AddressesBoolExp (simplified)" }, "phone": { "type": "object", "description": "StringComparisonExp (simplified)" }, "scacNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "shipment": { "type": "object", "description": "ShipmentsBoolExp (simplified)" }, "shipmentId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" } }, "title": "CarriersBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carriers": { "items": { "description": "columns and relationships of \"carriers\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/carriers/search" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carriers/{id}": { "get": { "summary": "Get One Carrier", "description": "Get a carrier by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" } } } } }, "description": "Responses for GET /api/rest/carriers/{id}" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Carrier", "description": "Update a carrier by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/CarriersSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCarrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/carriers/{id}" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Carrier", "description": "Delete a carrier by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCarrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Carriers", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/carriers/{id}" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-carriers": { "post": { "summary": "Create Many Carriers", "description": "Create multiple carriers at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/CarriersInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarriers": { "description": "response of any mutation on the table \"carriers\"", "nullable": true, "properties": { "returning": { "items": { "description": "columns and relationships of \"carriers\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Carriers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CarriersMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-carriers" } }, "tags": [ "Carriers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bill_line_items": { "post": { "summary": "Create One Bill Line Item", "description": "Create a new bill line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/BillLineItemsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createBillLineItem": { "description": "columns and relationships of \"bill_line_items\"", "nullable": true, "properties": { "billId": { "nullable": false, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bill_line_items" } }, "tags": [ "Bill Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bill_line_items/{id}": { "delete": { "summary": "Delete One Bill Line Item", "description": "Delete an bill line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteBillLineItem": { "description": "columns and relationships of \"bill_line_items\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "BillLineItems", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/bill_line_items/{id}" } }, "tags": [ "Bill Line Items" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Bill Line Item", "description": "Update an bill line item by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/BillLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateBillLineItem": { "description": "columns and relationships of \"bill_line_items\"", "nullable": true, "properties": { "billId": { "nullable": false, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/bill_line_items/{id}" } }, "tags": [ "Bill Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/stops": { "get": { "summary": "Get Many Stops", "description": "Query a list of stops", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/stops" } }, "tags": [ "Stops" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Stop", "description": "Create a new stop", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/StopsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createStop": { "description": "columns and relationships of \"stops\"", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" } } } } }, "description": "Responses for POST /api/rest/stops" } }, "tags": [ "Stops" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/stops/{id}": { "get": { "summary": "Get One Stop", "description": "Get a stop by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "stop": { "description": "columns and relationships of \"stops\"", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" } } } } }, "description": "Responses for GET /api/rest/stops/{id}" } }, "tags": [ "Stops" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Stop", "description": "Update a stop by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/StopsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateStop": { "description": "columns and relationships of \"stops\"", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/stops/{id}" } }, "tags": [ "Stops" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Stop", "description": "Delete a stop by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteStop": { "description": "columns and relationships of \"stops\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/stops/{id}" } }, "tags": [ "Stops" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendor-invoices": { "get": { "summary": "List Vendor Invoices", "description": "List recent vendor invoices (newest first). Optional `limit` query parameter caps the result count.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendorInvoices": { "items": { "description": "Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching", "nullable": false, "properties": { "accountNumber": { "nullable": true, "title": "String", "type": "string" }, "amountReceived": { "nullable": true, "title": "Int", "type": "integer" }, "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": false, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "invoiceDate": { "$ref": "#/components/schemas/date" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "matchedPurchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "matchedPurchaseOrderId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "orderDate": { "$ref": "#/components/schemas/date" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requisitionerName": { "nullable": true, "title": "String", "type": "string" }, "salesOrderNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "surchargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxExempt": { "nullable": true, "title": "Boolean", "type": "boolean" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "vendor": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "vendorInvoiceLineItems": { "items": { "description": "Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)", "nullable": false, "properties": { "chargeType": { "nullable": true, "title": "String", "type": "string" }, "customerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "discountPercent": { "$ref": "#/components/schemas/numeric" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "poLineNumber": { "nullable": true, "title": "String", "type": "string" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "quantityBackordered": { "$ref": "#/components/schemas/numeric" }, "quantityOrdered": { "$ref": "#/components/schemas/numeric" }, "quantityShipped": { "$ref": "#/components/schemas/numeric" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "SupportingDocsVendorInvoices", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/vendor-invoices" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendor-invoices/search": { "post": { "summary": "Search Vendor Invoices By Source System", "description": "Find the vendor invoice(s) created from a document you uploaded, keyed by the `sourceSystem` + `sourceSystemId` you supplied at presign time. Body: `{ \"sourceSystem\": \"...\", \"sourceSystemId\": \"...\" }`.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendorInvoices": { "items": { "description": "Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching", "nullable": false, "properties": { "accountNumber": { "nullable": true, "title": "String", "type": "string" }, "amountReceived": { "nullable": true, "title": "Int", "type": "integer" }, "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": false, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "invoiceDate": { "$ref": "#/components/schemas/date" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "matchedPurchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "matchedPurchaseOrderId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "orderDate": { "$ref": "#/components/schemas/date" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requisitionerName": { "nullable": true, "title": "String", "type": "string" }, "salesOrderNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "surchargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxExempt": { "nullable": true, "title": "Boolean", "type": "boolean" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "vendor": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "vendorInvoiceLineItems": { "items": { "description": "Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)", "nullable": false, "properties": { "chargeType": { "nullable": true, "title": "String", "type": "string" }, "customerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "discountPercent": { "$ref": "#/components/schemas/numeric" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "poLineNumber": { "nullable": true, "title": "String", "type": "string" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "quantityBackordered": { "$ref": "#/components/schemas/numeric" }, "quantityOrdered": { "$ref": "#/components/schemas/numeric" }, "quantityShipped": { "$ref": "#/components/schemas/numeric" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "SupportingDocsVendorInvoices", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/vendor-invoices/search" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendor-invoices/{id}": { "get": { "summary": "Get One Vendor Invoice", "description": "Get a parsed vendor invoice by id, including line items, party addresses, and the matched purchase order.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendorInvoice": { "description": "Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching", "nullable": true, "properties": { "accountNumber": { "nullable": true, "title": "String", "type": "string" }, "amountReceived": { "nullable": true, "title": "Int", "type": "integer" }, "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": false, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "invoiceDate": { "$ref": "#/components/schemas/date" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "matchedPurchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "matchedPurchaseOrderId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "orderDate": { "$ref": "#/components/schemas/date" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requisitionerName": { "nullable": true, "title": "String", "type": "string" }, "salesOrderNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "surchargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxExempt": { "nullable": true, "title": "Boolean", "type": "boolean" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "vendor": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "vendorInvoiceLineItems": { "items": { "description": "Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)", "nullable": false, "properties": { "chargeType": { "nullable": true, "title": "String", "type": "string" }, "customerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "discountPercent": { "$ref": "#/components/schemas/numeric" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "poLineNumber": { "nullable": true, "title": "String", "type": "string" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "quantityBackordered": { "$ref": "#/components/schemas/numeric" }, "quantityOrdered": { "$ref": "#/components/schemas/numeric" }, "quantityShipped": { "$ref": "#/components/schemas/numeric" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "SupportingDocsVendorInvoices", "type": "object" } } } } }, "description": "Responses for GET /api/rest/vendor-invoices/{id}" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Vendor Invoice", "description": "Update parsed vendor invoice header fields. Body: `{ \"input\": { ...fields to set... } }` using the record's camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/SupportingDocsVendorInvoicesSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateVendorInvoice": { "description": "Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoices", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/vendor-invoices/{id}" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/document_reference_specifications": { "get": { "summary": "Get Many Document Reference Specifications", "description": "Query a list of document reference specifications", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100 } }, { "in": "query", "name": "offset", "schema": { "type": "integer", "default": 0 } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "documentReferenceSpecifications": { "items": { "description": "columns and relationships of \"document_reference_specifications\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" } }, "title": "Customers", "type": "object" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecifications", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/document_reference_specifications" } }, "tags": [ "Document Reference Specifications" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Document Reference Specification", "description": "Create a new document reference specification", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/DocumentReferenceSpecificationsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createDocumentReferenceSpecification": { "description": "columns and relationships of \"document_reference_specifications\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecifications", "type": "object" } } } } }, "description": "Responses for POST /api/rest/document_reference_specifications" } }, "tags": [ "Document Reference Specifications" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/document_reference_specifications/{id}": { "get": { "summary": "Get One Document Reference Specification", "description": "Get a document reference specification by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "documentReferenceSpecification": { "description": "columns and relationships of \"document_reference_specifications\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" } }, "title": "Customers", "type": "object" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecifications", "type": "object" } } } } }, "description": "Responses for GET /api/rest/document_reference_specifications/{id}" } }, "tags": [ "Document Reference Specifications" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Document Reference Specification", "description": "Update a document reference specification by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/DocumentReferenceSpecificationsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateDocumentReferenceSpecification": { "description": "columns and relationships of \"document_reference_specifications\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecifications", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/document_reference_specifications/{id}" } }, "tags": [ "Document Reference Specifications" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Document Reference Specification", "description": "Delete a document reference specification by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteDocumentReferenceSpecification": { "description": "columns and relationships of \"document_reference_specifications\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "DocumentReferenceSpecifications", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/document_reference_specifications/{id}" } }, "tags": [ "Document Reference Specifications" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/vendor-invoice-line-items/{id}": { "patch": { "summary": "Update One Vendor Invoice Line Item", "description": "Update parsed vendor invoice line item fields. Body: `{ \"input\": { ...fields to set... } }` using the record's camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/SupportingDocsVendorInvoiceLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateVendorInvoiceLineItem": { "description": "Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItems", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/vendor-invoice-line-items/{id}" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payments": { "get": { "summary": "Get Many Customer Payments", "description": "Retrieve a list of customer payments", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPayments": { "items": { "description": "Payment records", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/customer_payments" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Customer Payment", "description": "Create a new customer payment", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/PaymentsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomerPayment": { "description": "Payment records", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" } } } } }, "description": "Responses for POST /api/rest/customer_payments" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payments/search": { "post": { "summary": "Search Customer Payments", "description": "Search for customer payments based on specified criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "PaymentsOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"payments\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "PaymentsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "PaymentsBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "PaymentsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "checkDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "checkOrAchNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "lifecycleEventAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "paymentLineItemsAggregate": { "type": "object", "description": "PaymentLineItemsAggregateBoolExp (simplified)" }, "paymentMethodType": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "status": { "type": "object", "description": "PaymentStatusesEnumComparisonExp (simplified)" }, "totalAmount": { "type": "object", "description": "IntComparisonExp (simplified)" }, "transactionDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" } }, "title": "PaymentsBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPayments": { "items": { "description": "Payment records", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/customer_payments/search" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payments/{id}": { "get": { "summary": "Get One Customer Payment", "description": "Retrieve details of a specific customer payment", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPayment": { "description": "Payment records", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" } } } } }, "description": "Responses for GET /api/rest/customer_payments/{id}" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Customer Payment", "description": "Update details of a specific customer payment", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/PaymentsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCustomerPayment": { "description": "Payment records", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/customer_payments/{id}" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Customer Payment", "description": "Delete a specific customer payment", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCustomerPayment": { "description": "Payment records", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Payments", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/customer_payments/{id}" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-bills": { "post": { "summary": "Create Many Bills", "description": "Create multiple bills at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/BillsInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createBills": { "description": "response of any mutation on the table \"bills\"", "nullable": true, "properties": { "returning": { "items": { "description": "columns and relationships of \"bills\"", "nullable": false, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" }, "nullable": false, "type": "array" } }, "title": "BillsMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-bills" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/documents/{id}": { "get": { "summary": "Get One Document", "description": "Get a document by id — the status check for API uploads. `status` of `UPLOAD_CONTENT_REJECTED` means the uploaded bytes failed content verification (not a valid PDF) and the document will never be parsed; re-upload with a new `sourceSystemId` (rejection is terminal: re-presigning the same `sourceSystem`+`sourceSystemId` returns `400 DOCUMENT_ALREADY_UPLOADED`). A null/other status with no parsed record yet means parsing is still in progress.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "document": { "description": "Documents table", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/DocumentTypeEnum" } }, "title": "Documents", "type": "object" } } } } }, "description": "Responses for GET /api/rest/documents/{id}" } }, "tags": [ "Documents" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Document", "description": "Update a document by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/DocumentsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateDocument": { "description": "Documents table", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Documents", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/documents/{id}" } }, "tags": [ "Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/documents/{documentId}/vendor-invoices": { "get": { "summary": "List Vendor Invoices By Document", "description": "Get the parsed vendor invoice(s) created from an uploaded document. Returns an empty list until parsing completes — poll after uploading to the presigned URL.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"documentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "documentId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "vendorInvoices": { "items": { "description": "Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching", "nullable": false, "properties": { "accountNumber": { "nullable": true, "title": "String", "type": "string" }, "amountReceived": { "nullable": true, "title": "Int", "type": "integer" }, "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": false, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "invoiceDate": { "$ref": "#/components/schemas/date" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "matchedPurchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "matchedPurchaseOrderId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "orderDate": { "$ref": "#/components/schemas/date" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requisitionerName": { "nullable": true, "title": "String", "type": "string" }, "salesOrderNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "surchargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxExempt": { "nullable": true, "title": "Boolean", "type": "boolean" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "vendor": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "vendorInvoiceLineItems": { "items": { "description": "Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)", "nullable": false, "properties": { "chargeType": { "nullable": true, "title": "String", "type": "string" }, "customerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "discountPercent": { "$ref": "#/components/schemas/numeric" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "poLineNumber": { "nullable": true, "title": "String", "type": "string" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "quantityBackordered": { "$ref": "#/components/schemas/numeric" }, "quantityOrdered": { "$ref": "#/components/schemas/numeric" }, "quantityShipped": { "$ref": "#/components/schemas/numeric" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "SupportingDocsVendorInvoices", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/documents/{documentId}/vendor-invoices" } }, "tags": [ "Vendor Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/documents/{documentId}/purchase-orders": { "get": { "summary": "List Purchase Orders By Document", "description": "Get the parsed purchase order(s) created from an uploaded document. Returns an empty list until parsing completes — poll after uploading to the presigned URL.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"documentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "documentId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "purchaseOrders": { "items": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": false, "properties": { "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "buyerContactName": { "nullable": true, "title": "String", "type": "string" }, "buyerEmail": { "nullable": true, "title": "String", "type": "string" }, "buyerName": { "nullable": true, "title": "String", "type": "string" }, "buyerPhone": { "nullable": true, "title": "String", "type": "string" }, "cancelAfterDate": { "$ref": "#/components/schemas/date" }, "confirmToEmail": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightTerms": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "miscChargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "pickupDate": { "$ref": "#/components/schemas/date" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "poType": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "purchaseOrderLineItems": { "items": { "description": "Purchase Order line items (EDI 850 PO1-loop-shaped)", "nullable": false, "properties": { "brand": { "nullable": true, "title": "String", "type": "string" }, "buyerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "manufacturerName": { "nullable": true, "title": "String", "type": "string" }, "manufacturerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "packSize": { "nullable": true, "title": "String", "type": "string" }, "promisedDeliveryDate": { "$ref": "#/components/schemas/date" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "revision": { "nullable": true, "title": "String", "type": "string" }, "schedules": { "$ref": "#/components/schemas/jsonb" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "upc": { "nullable": true, "title": "String", "type": "string" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItems", "type": "object" }, "nullable": false, "type": "array" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseNumber": { "nullable": true, "title": "String", "type": "string" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "requestedShipDate": { "$ref": "#/components/schemas/date" }, "requesterName": { "nullable": true, "title": "String", "type": "string" }, "requisitionNumber": { "nullable": true, "title": "String", "type": "string" }, "revisionDate": { "$ref": "#/components/schemas/date" }, "revisionNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipToCode": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "supplier": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalQuantity": { "$ref": "#/components/schemas/numeric" }, "totalVolume": { "$ref": "#/components/schemas/numeric" }, "totalWeight": { "$ref": "#/components/schemas/numeric" }, "vendorInstructions": { "nullable": true, "title": "String", "type": "string" }, "vendorNumber": { "nullable": true, "title": "String", "type": "string" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/documents/{documentId}/purchase-orders" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-customer-payment-line-items": { "post": { "summary": "Create Many Customer Payment Line Items", "description": "Create multiple customer payment line items at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/PaymentLineItemsInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomerPaymentLineItems": { "description": "response of any mutation on the table \"payment_line_items\"", "nullable": true, "properties": { "returning": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" } }, "title": "PaymentLineItemsMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-customer-payment-line-items" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/rules": { "get": { "summary": "Get Many Rules", "description": "Query a list of rules", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 100, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rules": { "items": { "description": "Rules used for matching, document requirements, etc", "nullable": false, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "priority": { "nullable": false, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "Rules", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/rules" } }, "tags": [ "Rules" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Rule", "description": "Create a new rule", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/RulesInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createRule": { "description": "Rules used for matching, document requirements, etc", "nullable": true, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "priority": { "nullable": false, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "Rules", "type": "object" } } } } }, "description": "Responses for POST /api/rest/rules" } }, "tags": [ "Rules" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/rules/{id}": { "get": { "summary": "Get One Rule", "description": "Get a rule by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "rule": { "description": "Rules used for matching, document requirements, etc", "nullable": true, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "priority": { "nullable": false, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "Rules", "type": "object" } } } } }, "description": "Responses for GET /api/rest/rules/{id}" } }, "tags": [ "Rules" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Rule", "description": "Update a rule by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/RulesSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateRule": { "description": "Rules used for matching, document requirements, etc", "nullable": true, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "priority": { "nullable": false, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "Rules", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/rules/{id}" } }, "tags": [ "Rules" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Rule", "description": "Delete a rule by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteRule": { "description": "Rules used for matching, document requirements, etc", "nullable": true, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "priority": { "nullable": false, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "Rules", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/rules/{id}" } }, "tags": [ "Rules" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoice_shipments": { "post": { "summary": "Link invoice to shipment", "description": "Create an association between an invoice and a shipment.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"invoiceId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "invoiceId", "schema": { "type": "string" } }, { "description": "_\"shipmentId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "shipmentId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "insertInvoiceShipmentsOne": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" } } } } }, "description": "Responses for POST /api/rest/invoice_shipments" } }, "tags": [ "Invoice Shipments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoice_shipments/{invoiceId}/{shipmentId}": { "delete": { "summary": "Unlink invoice from shipment", "description": "Remove the association between an invoice and a shipment.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"invoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "invoiceId", "schema": { "type": "string" }, "required": true }, { "description": "_\"shipmentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "shipmentId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteInvoiceShipmentsByPk": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": true, "properties": { "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/invoice_shipments/{invoiceId}/{shipmentId}" } }, "tags": [ "Invoice Shipments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/companies": { "get": { "summary": "List companies", "description": "Retrieve a paginated list of companies with optional filtering and sorting.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "companies": { "items": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/companies" } }, "tags": [ "Companies" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create company", "description": "Create a new company record.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CompaniesInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCompany": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" } } } } }, "description": "Responses for POST /api/rest/companies" } }, "tags": [ "Companies" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/companies/{id}": { "get": { "summary": "Get company", "description": "Retrieve a single company by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" } } } } }, "description": "Responses for GET /api/rest/companies/{id}" } }, "tags": [ "Companies" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update company", "description": "Update an existing company by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/CompaniesSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCompany": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/companies/{id}" } }, "tags": [ "Companies" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete company", "description": "Delete a company by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCompany": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/companies/{id}" } }, "tags": [ "Companies" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bills": { "get": { "summary": "Get Many Bills", "description": "Query a list of bills", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bills": { "items": { "description": "columns and relationships of \"bills\"", "nullable": false, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/bills" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Bill", "description": "Create a new bill", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/BillsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createBill": { "description": "columns and relationships of \"bills\"", "nullable": true, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bills" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bills/search": { "post": { "summary": "Search Bills", "description": "Advanced search for bills with complex filtering criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "BillsOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"bills\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "BillsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "BillsBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "BillsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "billLineItems": { "type": "object", "description": "BillLineItemsBoolExp (simplified)" }, "billLineItemsAggregate": { "type": "object", "description": "BillLineItemsAggregateBoolExp (simplified)" }, "billLineItemsLastUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "billPaymentLineItems": { "type": "object", "description": "BillPaymentLineItemsBoolExp (simplified)" }, "billPaymentLineItemsAggregate": { "type": "object", "description": "BillPaymentLineItemsAggregateBoolExp (simplified)" }, "carrier": { "type": "object", "description": "CarriersBoolExp (simplified)" }, "carrierId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "carrierInvoices": { "type": "object", "description": "CarrierInvoicesBoolExp (simplified)" }, "carrierInvoicesAggregate": { "type": "object", "description": "CarrierInvoicesAggregateBoolExp (simplified)" }, "checkOrAchNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "dispatcherEmail": { "type": "object", "description": "StringComparisonExp (simplified)" }, "dueDate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "issueDate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "mcleodSettlementTransferError": { "type": "object", "description": "StringComparisonExp (simplified)" }, "mcleodSettlementTransferResponse": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "mcleodSettlementTransferredAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "notes": { "type": "object", "description": "StringComparisonExp (simplified)" }, "payToAccount": { "type": "object", "description": "StringComparisonExp (simplified)" }, "proNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "referenceNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "status": { "type": "object", "description": "StringComparisonExp (simplified)" }, "terms": { "type": "object", "description": "StringComparisonExp (simplified)" }, "totalAmount": { "type": "object", "description": "IntComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "vendor": { "type": "object", "description": "VendorsBoolExp (simplified)" }, "vendorId": { "type": "object", "description": "StringComparisonExp (simplified)" } }, "title": "BillsBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bills": { "items": { "description": "columns and relationships of \"bills\"", "nullable": false, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/bills/search" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bills/{id}": { "get": { "summary": "Get One Bill", "description": "Get a bill by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "bill": { "description": "columns and relationships of \"bills\"", "nullable": true, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" } } } } }, "description": "Responses for GET /api/rest/bills/{id}" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Bill", "description": "Update a bill by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "default": {}, "description": "input type for updating data in table \"bills\"", "nullable": true, "properties": { "billLineItemsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "mcleodSettlementTransferError": { "nullable": true, "title": "String", "type": "string" }, "mcleodSettlementTransferResponse": { "$ref": "#/components/schemas/jsonb" }, "mcleodSettlementTransferredAt": { "$ref": "#/components/schemas/timestamptz" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "BillsSetInput", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateBill": { "description": "columns and relationships of \"bills\"", "nullable": true, "properties": { "billLineItems": { "items": { "description": "columns and relationships of \"bill_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": false, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": false, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": false, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "description": "Vendors", "nullable": true, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Vendors", "type": "object" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/bills/{id}" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Bill", "description": "Delete a bill by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteBill": { "description": "columns and relationships of \"bills\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Bills", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/bills/{id}" } }, "tags": [ "Bills" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/purchase-orders": { "get": { "summary": "List Purchase Orders", "description": "List recent purchase orders (newest first). Optional `limit` query parameter caps the result count.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "purchaseOrders": { "items": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": false, "properties": { "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "buyerContactName": { "nullable": true, "title": "String", "type": "string" }, "buyerEmail": { "nullable": true, "title": "String", "type": "string" }, "buyerName": { "nullable": true, "title": "String", "type": "string" }, "buyerPhone": { "nullable": true, "title": "String", "type": "string" }, "cancelAfterDate": { "$ref": "#/components/schemas/date" }, "confirmToEmail": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightTerms": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "miscChargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "pickupDate": { "$ref": "#/components/schemas/date" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "poType": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "purchaseOrderLineItems": { "items": { "description": "Purchase Order line items (EDI 850 PO1-loop-shaped)", "nullable": false, "properties": { "brand": { "nullable": true, "title": "String", "type": "string" }, "buyerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "manufacturerName": { "nullable": true, "title": "String", "type": "string" }, "manufacturerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "packSize": { "nullable": true, "title": "String", "type": "string" }, "promisedDeliveryDate": { "$ref": "#/components/schemas/date" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "revision": { "nullable": true, "title": "String", "type": "string" }, "schedules": { "$ref": "#/components/schemas/jsonb" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "upc": { "nullable": true, "title": "String", "type": "string" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItems", "type": "object" }, "nullable": false, "type": "array" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseNumber": { "nullable": true, "title": "String", "type": "string" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "requestedShipDate": { "$ref": "#/components/schemas/date" }, "requesterName": { "nullable": true, "title": "String", "type": "string" }, "requisitionNumber": { "nullable": true, "title": "String", "type": "string" }, "revisionDate": { "$ref": "#/components/schemas/date" }, "revisionNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipToCode": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "supplier": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalQuantity": { "$ref": "#/components/schemas/numeric" }, "totalVolume": { "$ref": "#/components/schemas/numeric" }, "totalWeight": { "$ref": "#/components/schemas/numeric" }, "vendorInstructions": { "nullable": true, "title": "String", "type": "string" }, "vendorNumber": { "nullable": true, "title": "String", "type": "string" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/purchase-orders" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/purchase-orders/search": { "post": { "summary": "Search Purchase Orders By Source System", "description": "Find the purchase order(s) created from a document you uploaded, keyed by the `sourceSystem` + `sourceSystemId` you supplied at presign time. Body: `{ \"sourceSystem\": \"...\", \"sourceSystemId\": \"...\" }`.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "purchaseOrders": { "items": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": false, "properties": { "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "buyerContactName": { "nullable": true, "title": "String", "type": "string" }, "buyerEmail": { "nullable": true, "title": "String", "type": "string" }, "buyerName": { "nullable": true, "title": "String", "type": "string" }, "buyerPhone": { "nullable": true, "title": "String", "type": "string" }, "cancelAfterDate": { "$ref": "#/components/schemas/date" }, "confirmToEmail": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightTerms": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "miscChargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "pickupDate": { "$ref": "#/components/schemas/date" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "poType": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "purchaseOrderLineItems": { "items": { "description": "Purchase Order line items (EDI 850 PO1-loop-shaped)", "nullable": false, "properties": { "brand": { "nullable": true, "title": "String", "type": "string" }, "buyerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "manufacturerName": { "nullable": true, "title": "String", "type": "string" }, "manufacturerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "packSize": { "nullable": true, "title": "String", "type": "string" }, "promisedDeliveryDate": { "$ref": "#/components/schemas/date" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "revision": { "nullable": true, "title": "String", "type": "string" }, "schedules": { "$ref": "#/components/schemas/jsonb" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "upc": { "nullable": true, "title": "String", "type": "string" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItems", "type": "object" }, "nullable": false, "type": "array" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseNumber": { "nullable": true, "title": "String", "type": "string" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "requestedShipDate": { "$ref": "#/components/schemas/date" }, "requesterName": { "nullable": true, "title": "String", "type": "string" }, "requisitionNumber": { "nullable": true, "title": "String", "type": "string" }, "revisionDate": { "$ref": "#/components/schemas/date" }, "revisionNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipToCode": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "supplier": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalQuantity": { "$ref": "#/components/schemas/numeric" }, "totalVolume": { "$ref": "#/components/schemas/numeric" }, "totalWeight": { "$ref": "#/components/schemas/numeric" }, "vendorInstructions": { "nullable": true, "title": "String", "type": "string" }, "vendorNumber": { "nullable": true, "title": "String", "type": "string" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/purchase-orders/search" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/purchase-orders/{id}": { "get": { "summary": "Get One Purchase Order", "description": "Get a parsed purchase order by id, including line items and party addresses.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "purchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "annotations": { "items": { "description": "Document Annotations", "nullable": false, "properties": { "confidence": { "nullable": false, "title": "Int", "type": "integer" }, "fieldLabel": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "markType": { "$ref": "#/components/schemas/SupportingDocsMarkTypeEnum" }, "pageNumber": { "nullable": true, "title": "Int", "type": "integer" }, "reasoning": { "nullable": true, "title": "String", "type": "string" }, "stampTitle": { "nullable": true, "title": "String", "type": "string" }, "text": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/SupportingDocsAnnotationTypeEnum" }, "valueDate": { "$ref": "#/components/schemas/date" }, "valueNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsDocumentAnnotations", "type": "object" }, "nullable": false, "type": "array" }, "billTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "buyerContactName": { "nullable": true, "title": "String", "type": "string" }, "buyerEmail": { "nullable": true, "title": "String", "type": "string" }, "buyerName": { "nullable": true, "title": "String", "type": "string" }, "buyerPhone": { "nullable": true, "title": "String", "type": "string" }, "cancelAfterDate": { "$ref": "#/components/schemas/date" }, "confirmToEmail": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightTerms": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "miscChargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "pickupDate": { "$ref": "#/components/schemas/date" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "poType": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "purchaseOrderLineItems": { "items": { "description": "Purchase Order line items (EDI 850 PO1-loop-shaped)", "nullable": false, "properties": { "brand": { "nullable": true, "title": "String", "type": "string" }, "buyerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "manufacturerName": { "nullable": true, "title": "String", "type": "string" }, "manufacturerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "packSize": { "nullable": true, "title": "String", "type": "string" }, "promisedDeliveryDate": { "$ref": "#/components/schemas/date" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "revision": { "nullable": true, "title": "String", "type": "string" }, "schedules": { "$ref": "#/components/schemas/jsonb" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "upc": { "nullable": true, "title": "String", "type": "string" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItems", "type": "object" }, "nullable": false, "type": "array" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseNumber": { "nullable": true, "title": "String", "type": "string" }, "remitTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "requestedShipDate": { "$ref": "#/components/schemas/date" }, "requesterName": { "nullable": true, "title": "String", "type": "string" }, "requisitionNumber": { "nullable": true, "title": "String", "type": "string" }, "revisionDate": { "$ref": "#/components/schemas/date" }, "revisionNumber": { "nullable": true, "title": "String", "type": "string" }, "shipTo": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "shipToCode": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "supplier": { "description": "Supporting Document Party", "nullable": true, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "email": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsSupportingDocParty", "type": "object" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalQuantity": { "$ref": "#/components/schemas/numeric" }, "totalVolume": { "$ref": "#/components/schemas/numeric" }, "totalWeight": { "$ref": "#/components/schemas/numeric" }, "vendorInstructions": { "nullable": true, "title": "String", "type": "string" }, "vendorNumber": { "nullable": true, "title": "String", "type": "string" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" } } } } }, "description": "Responses for GET /api/rest/purchase-orders/{id}" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Purchase Order", "description": "Update parsed purchase order header fields. Body: `{ \"input\": { ...fields to set... } }` using the record's camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/SupportingDocsPurchaseOrdersSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updatePurchaseOrder": { "description": "Purchase Order supporting document - parsed data from PURCHASE_ORDER documents (inbound POs from the tenant's customers), modeled for EDI 850-series generation", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrders", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/purchase-orders/{id}" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices": { "get": { "summary": "Get Many Invoices", "description": "Query a list of invoices", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoices": { "items": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "items": { "description": "Exceptions", "nullable": false, "properties": { "details": { "$ref": "#/components/schemas/jsonb" }, "id": { "nullable": false, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/ExceptionStatusEnum" }, "type": { "$ref": "#/components/schemas/ExceptionTypeEnum" } }, "title": "Exceptions", "type": "object" }, "nullable": false, "type": "array" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "invoiceShipments": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "missingDocuments": { "nullable": true, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array" }, "invoicesAggregate": { "description": "aggregated selection of \"invoices\"", "nullable": false, "properties": { "aggregate": { "description": "aggregate fields of \"invoices\"", "nullable": true, "properties": { "avg": { "description": "aggregate avg on columns", "nullable": true, "properties": { "balance": { "nullable": true, "title": "Float", "type": "number" }, "totalAmount": { "nullable": true, "title": "Float", "type": "number" }, "totalTaxAmount": { "nullable": true, "title": "Float", "type": "number" } }, "title": "InvoicesAvgFields", "type": "object" }, "count": { "nullable": false, "title": "Int", "type": "integer" }, "sum": { "description": "aggregate sum on columns", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" } }, "title": "InvoicesSumFields", "type": "object" } }, "title": "InvoicesAggregateFields", "type": "object" } }, "title": "InvoicesAggregate", "type": "object" } } } } }, "description": "Responses for GET /api/rest/invoices" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Invoice By Source System Id", "description": "Update an invoice by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "default": {}, "description": "input type for updating data in table \"invoices\"", "nullable": true, "properties": { "approvedToSend": { "nullable": true, "title": "Boolean", "type": "boolean" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "debitsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryDate": { "$ref": "#/components/schemas/date" }, "deliveryMethods": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "documentExceptions": { "$ref": "#/components/schemas/jsonb" }, "dueDate": { "$ref": "#/components/schemas/date" }, "externallyManaged": { "nullable": true, "title": "Boolean", "type": "boolean" }, "fileAssociationsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "finalCheckPassedAt": { "$ref": "#/components/schemas/timestamptz" }, "holdForReview": { "nullable": true, "title": "Boolean", "type": "boolean" }, "id": { "nullable": true, "title": "String", "type": "string" }, "invoiceCreationEventId": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "lastUpdatedByEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "lineItemsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "number": { "nullable": true, "title": "String", "type": "string" }, "paidDate": { "$ref": "#/components/schemas/timestamptz" }, "portalException": { "nullable": true, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/timestamp" }, "receivedFromPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "scacCode": { "nullable": true, "title": "String", "type": "string" }, "scheduledPaymentDate": { "$ref": "#/components/schemas/date" }, "sentAt": { "$ref": "#/components/schemas/timestamp" }, "sentToPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "shipDate": { "$ref": "#/components/schemas/date" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "statementId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "supportingDocPacketBuiltAgainstAt": { "$ref": "#/components/schemas/timestamp" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoicesSetInput", "type": "object" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateInvoice": { "description": "response of any mutation on the table \"invoices\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "invoiceShipments": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "missingDocuments": { "nullable": true, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array" } }, "title": "InvoicesMutationResponse", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/invoices" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Invoice", "description": "Create a new invoice.\n\n**Integration notes:**\n- `POST` errors with `400 Uniqueness violation` on duplicate `(sourceSystem, sourceSystemId)`. Use `PUT` for updates.\n- `balance` is `NOT NULL` with no server-side default — for a new invoice it should equal `totalAmount`.\n- `totalAmount` (and other monetary fields) are integer cents, not float dollars.\n- The invoice number field is `number` (not `invoiceNumber`) and the issue date is `issueDate` (not `invoiceDate`).\n\nSee [Integration patterns](/integration-patterns).", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/InvoicesInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createInvoice": { "description": "columns and relationships of \"invoices\"", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "invoiceShipments": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "missingDocuments": { "nullable": true, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" } } } } }, "description": "Responses for POST /api/rest/invoices" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Invoice By Source System Id", "description": "Delete an invoice by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteInvoice": { "description": "response of any mutation on the table \"invoices\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array" } }, "title": "InvoicesMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/invoices" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/queues/ready-for-approval": { "get": { "summary": "List invoices ready for approval", "description": "Retrieve a paginated list of customer invoices that are ready for approval. Returns invoices in CREATED status with approvedToSend=false and no open exceptions.", "parameters": [ { "description": "Your API key for authentication", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" }, "description": "Maximum number of invoices to return" }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" }, "description": "Number of invoices to skip for pagination" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoices": { "items": { "description": "Invoice details", "nullable": false, "properties": { "approvedToSend": { "nullable": true, "title": "Boolean", "type": "boolean", "description": "Whether the invoice has been approved to send" }, "createdAt": { "$ref": "#/components/schemas/timestamptz", "description": "Timestamp when the invoice was created", "type": "string", "format": "date-time" }, "customer": { "description": "Customer associated with the invoice", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string", "description": "Customer unique identifier" }, "name": { "nullable": true, "title": "String", "type": "string", "description": "Customer name" } }, "title": "Customers", "type": "object" }, "customerId": { "nullable": true, "title": "String", "type": "string", "description": "ID of the customer" }, "id": { "nullable": false, "title": "String", "type": "string", "description": "Invoice unique identifier" }, "issueDate": { "$ref": "#/components/schemas/date", "description": "Date the invoice was issued", "type": "string", "format": "date" }, "number": { "nullable": false, "title": "String", "type": "string", "description": "Invoice number" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum", "description": "Current status of the invoice", "type": "string" }, "totalAmount": { "$ref": "#/components/schemas/bigint", "description": "Total amount of the invoice in cents", "type": "integer" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array", "description": "Array of invoices ready for approval" }, "invoicesAggregate": { "description": "Aggregate information about the query results", "nullable": false, "properties": { "aggregate": { "description": "Aggregate counts", "nullable": true, "properties": { "count": { "nullable": false, "title": "Int", "type": "integer", "description": "Total number of invoices matching the query" } }, "title": "InvoicesAggregateFields", "type": "object" } }, "title": "InvoicesAggregate", "type": "object" } }, "type": "object" } } }, "description": "List of invoices ready for approval" } }, "tags": [ "Invoice Approval" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/queues/ready-to-send": { "get": { "summary": "List invoices ready to send", "description": "Retrieve a paginated list of customer invoices in the Pre-Invoice Audit Ready To Send queue. Returns CREATED invoices that are not on hold, have a customer, have no open exceptions, are not scheduled, are not manual portal work, and may have approvedToSend either true or false.", "parameters": [ { "description": "Your API key for authentication", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" }, "description": "Maximum number of invoices to return" }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" }, "description": "Number of invoices to skip for pagination" } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoices": { "items": { "description": "Invoice details", "nullable": false, "properties": { "approvedToSend": { "nullable": true, "title": "Boolean", "type": "boolean", "description": "Whether the invoice has been approved to send" }, "createdAt": { "$ref": "#/components/schemas/timestamptz", "description": "Timestamp when the invoice was created", "type": "string", "format": "date-time" }, "customer": { "description": "Customer associated with the invoice", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string", "description": "Customer unique identifier" }, "name": { "nullable": true, "title": "String", "type": "string", "description": "Customer name" } }, "title": "Customers", "type": "object" }, "customerId": { "nullable": true, "title": "String", "type": "string", "description": "ID of the customer" }, "holdForReview": { "nullable": false, "title": "Boolean", "type": "boolean", "description": "Whether the invoice is currently on hold for review" }, "id": { "nullable": false, "title": "String", "type": "string", "description": "Invoice unique identifier" }, "issueDate": { "$ref": "#/components/schemas/date", "description": "Date the invoice was issued", "type": "string", "format": "date" }, "number": { "nullable": false, "title": "String", "type": "string", "description": "Invoice number" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum", "description": "Current status of the invoice", "type": "string" }, "totalAmount": { "$ref": "#/components/schemas/bigint", "description": "Total amount of the invoice in cents", "type": "integer" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array", "description": "Array of invoices ready to send" }, "invoicesAggregate": { "description": "Aggregate information about the query results", "nullable": false, "properties": { "aggregate": { "description": "Aggregate counts", "nullable": true, "properties": { "count": { "nullable": false, "title": "Int", "type": "integer", "description": "Total number of invoices matching the query" } }, "title": "InvoicesAggregateFields", "type": "object" } }, "title": "InvoicesAggregate", "type": "object" } }, "type": "object" } } }, "description": "List of invoices ready to send" } }, "tags": [ "Invoice Approval" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/search": { "post": { "summary": "Search Invoices", "description": "Search for invoices by source system and source system ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": [], "items": { "type": "object", "description": "InvoicesOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"invoices\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "InvoicesBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "InvoicesBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "InvoicesBoolExp (simplified)" }, "nullable": true, "type": "array" }, "approvedToSend": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "balance": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "billOfLadingNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "billToCustomer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "billToCustomerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "carrierProNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "checkOrAchNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "companyDivision": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedDaysOverdue": { "type": "object", "description": "IntComparisonExp (simplified)" }, "computedDisplayStatus": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedInvoiceDetails": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "computedMissingDocuments": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedPortalSlug": { "type": "object", "description": "StringComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "createdFromEmailMessage": { "type": "object", "description": "EmailMessagesBoolExp (simplified)" }, "createdFromEmailMessageId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "customer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "customerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "customerPoNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "customerReferenceNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "debits": { "type": "object", "description": "DebitsBoolExp (simplified)" }, "debitsAggregate": { "type": "object", "description": "DebitsAggregateBoolExp (simplified)" }, "debitsUpdatedAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "deliveryDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "deliveryMethods": { "type": "object", "description": "StringArrayComparisonExp (simplified)" }, "documentExceptions": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "dueDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "eval": { "type": "object", "description": "EvalsBoolExp (simplified)" }, "exceptions": { "type": "object", "description": "ExceptionsBoolExp (simplified)" }, "exceptionsAggregate": { "type": "object", "description": "ExceptionsAggregateBoolExp (simplified)" }, "externallyManaged": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "fileAssociations": { "type": "object", "description": "FileAssociationsBoolExp (simplified)" }, "fileAssociationsAggregate": { "type": "object", "description": "FileAssociationsAggregateBoolExp (simplified)" }, "fileAssociationsUpdatedAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "finalCheckPassedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "holdForReview": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoiceActivities": { "type": "object", "description": "InvoiceActivityBoolExp (simplified)" }, "invoiceActivitiesAggregate": { "type": "object", "description": "InvoiceActivityAggregateBoolExp (simplified)" }, "invoiceCreationEvent": { "type": "object", "description": "InvoiceCreationEventsBoolExp (simplified)" }, "invoiceCreationEventId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoiceErrors": { "type": "object", "description": "InvoiceErrorsBoolExp (simplified)" }, "invoiceErrorsAggregate": { "type": "object", "description": "InvoiceErrorsAggregateBoolExp (simplified)" }, "invoiceLineItems": { "type": "object", "description": "InvoiceLineItemsBoolExp (simplified)" }, "invoiceLineItemsAggregate": { "type": "object", "description": "InvoiceLineItemsAggregateBoolExp (simplified)" }, "invoicePriorityActions": { "type": "object", "description": "InvoicePriorityActionsBoolExp (simplified)" }, "invoicePriorityActionsAggregate": { "type": "object", "description": "InvoicePriorityActionsAggregateBoolExp (simplified)" }, "invoiceShipments": { "type": "object", "description": "InvoiceShipmentsBoolExp (simplified)" }, "invoiceShipmentsAggregate": { "type": "object", "description": "InvoiceShipmentsAggregateBoolExp (simplified)" }, "invoiceSnooze": { "type": "object", "description": "InvoiceSnoozesBoolExp (simplified)" }, "invoiceSnoozes": { "type": "object", "description": "InvoiceSnoozesBoolExp (simplified)" }, "invoiceSnoozesAggregate": { "type": "object", "description": "InvoiceSnoozesAggregateBoolExp (simplified)" }, "issueDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "lastUpdatedByEmailMessageId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "lineItemsLastUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "listBillDeliveryInvoices": { "type": "object", "description": "ListBillDeliveryInvoicesBoolExp (simplified)" }, "listBillDeliveryInvoicesAggregate": { "type": "object", "description": "ListBillDeliveryInvoicesAggregateBoolExp (simplified)" }, "metadata": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "notes": { "type": "object", "description": "NotesBoolExp (simplified)" }, "notesAggregate": { "type": "object", "description": "NotesAggregateBoolExp (simplified)" }, "number": { "type": "object", "description": "StringComparisonExp (simplified)" }, "paidDate": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "paymentLineItemsAggregate": { "type": "object", "description": "PaymentLineItemsAggregateBoolExp (simplified)" }, "portalException": { "type": "object", "description": "StringComparisonExp (simplified)" }, "portalInvoiceStatuses": { "type": "object", "description": "PortalInvoiceStatusesBoolExp (simplified)" }, "portalInvoiceStatusesAggregate": { "type": "object", "description": "PortalInvoiceStatusesAggregateBoolExp (simplified)" }, "portalSlug": { "type": "object", "description": "StringComparisonExp (simplified)" }, "receivedAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "receivedFromPortalSlug": { "type": "object", "description": "StringComparisonExp (simplified)" }, "referenceNumbers": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "reminders": { "type": "object", "description": "RemindersBoolExp (simplified)" }, "remindersAggregate": { "type": "object", "description": "RemindersAggregateBoolExp (simplified)" }, "remittance_line_item": { "type": "object", "description": "RemittanceLineItemsBoolExp (simplified)" }, "scacCode": { "type": "object", "description": "StringComparisonExp (simplified)" }, "scheduledPaymentDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "sentAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "sentToPortalSlug": { "type": "object", "description": "StringComparisonExp (simplified)" }, "shipDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "splitLineage": { "type": "object", "description": "InvoiceSplitLineageBoolExp (simplified)" }, "statement": { "type": "object", "description": "StatementsBoolExp (simplified)" }, "statementId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "statements": { "type": "object", "description": "StatementsBoolExp (simplified)" }, "statementsAggregate": { "type": "object", "description": "StatementsAggregateBoolExp (simplified)" }, "status": { "type": "object", "description": "InvoiceStatusEnumComparisonExp (simplified)" }, "supportingDocPacketBuiltAgainstAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "supportingDocPacketIsCurrent": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "totalAmount": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "totalTaxAmount": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" } }, "title": "InvoicesBoolExp", "type": "object" }, "sourceSystem": { "title": "Source System", "type": "string", "description": "The source system identifier" }, "sourceSystemId": { "title": "Source System ID", "type": "string", "description": "The ID of the invoice in the source system" } }, "type": "object", "required": [ "sourceSystem", "sourceSystemId" ] } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoices": { "items": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "customer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" } }, "title": "Customers", "type": "object" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "number": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/invoices/search" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/{id}": { "get": { "summary": "Get One Invoice", "description": "Get an invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "items": { "description": "Exceptions", "nullable": false, "properties": { "details": { "$ref": "#/components/schemas/jsonb" }, "id": { "nullable": false, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/ExceptionStatusEnum" }, "type": { "$ref": "#/components/schemas/ExceptionTypeEnum" } }, "title": "Exceptions", "type": "object" }, "nullable": false, "type": "array" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "invoiceShipments": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "missingDocuments": { "nullable": true, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" } } } } }, "description": "Responses for GET /api/rest/invoices/{id}" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Invoice", "description": "Update an invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "default": {}, "description": "input type for updating data in table \"invoices\"", "nullable": true, "properties": { "approvedToSend": { "nullable": true, "title": "Boolean", "type": "boolean" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "debitsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryDate": { "$ref": "#/components/schemas/date" }, "documentExceptions": { "$ref": "#/components/schemas/jsonb" }, "dueDate": { "$ref": "#/components/schemas/date" }, "externallyManaged": { "nullable": true, "title": "Boolean", "type": "boolean" }, "fileAssociationsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "finalCheckPassedAt": { "$ref": "#/components/schemas/timestamptz" }, "issueDate": { "$ref": "#/components/schemas/date" }, "lastUpdatedByEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "lineItemsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "number": { "nullable": true, "title": "String", "type": "string" }, "paidDate": { "$ref": "#/components/schemas/timestamptz" }, "portalException": { "nullable": true, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/timestamp" }, "receivedFromPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "scacCode": { "nullable": true, "title": "String", "type": "string" }, "scheduledPaymentDate": { "$ref": "#/components/schemas/date" }, "sentAt": { "$ref": "#/components/schemas/timestamp" }, "sentToPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "shipDate": { "$ref": "#/components/schemas/date" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum", "enum": [ "created", "open", "sent", "viewed", "paid", "part-paid", "disputed", "overdue", "cancelled", "write-off", "refunded", "send-error" ] }, "supportingDocPacketBuiltAgainstAt": { "$ref": "#/components/schemas/timestamp" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" } }, "title": "InvoicesSetInput", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateInvoice": { "description": "columns and relationships of \"invoices\"", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceLineItems": { "items": { "description": "columns and relationships of \"invoice_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "InvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "invoiceShipments": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "issueDate": { "$ref": "#/components/schemas/date" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "missingDocuments": { "nullable": true, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "totalAmount": { "$ref": "#/components/schemas/bigint" }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Invoices", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/invoices/{id}" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Invoice", "description": "Delete an invoice by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteInvoice": { "description": "columns and relationships of \"invoices\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/invoices/{id}" } }, "tags": [ "Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/{invoiceId}/documents": { "get": { "summary": "Get Many Invoice Documents", "description": "Query a list of invoice documents", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"invoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "invoiceId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "invoiceDocumentsByInvoiceId": { "items": { "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/DateTime" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "filename": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/DateTime" }, "url": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceDocument", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/invoices/{invoiceId}/documents" } }, "tags": [ "Invoice Documents" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create Invoice Document", "description": "Create a new invoice document", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"invoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "invoiceId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CreateInvoiceDocumentInput" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createInvoiceDocument": { "nullable": false, "properties": { "documentId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceDocument", "type": "object" } } } } }, "description": "Responses for POST /api/rest/invoices/{invoiceId}/documents" } }, "tags": [ "Invoice Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/{invoiceId}/documents/{id}": { "delete": { "summary": "Delete Invoice Document", "description": "Delete an invoice document by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "description": "_\"invoiceId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "invoiceId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteFileAssociations": { "description": "response of any mutation on the table \"file_associations\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "Relationships for files", "nullable": false, "properties": { "associationId": { "nullable": false, "title": "String", "type": "string" }, "fileId": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "FileAssociations", "type": "object" }, "nullable": false, "type": "array" } }, "title": "FileAssociationsMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/invoices/{invoiceId}/documents/{id}" } }, "tags": [ "Invoice Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/invoices/{id}/approve": { "post": { "summary": "Approve customer invoice", "description": "Approve a customer invoice for sending. If the invoice has open exceptions, approval will fail unless overrideExceptions=true is passed, which will close all open exceptions and approve the invoice.", "parameters": [ { "description": "Your API key for authentication", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "The ID of the invoice to approve", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "in": "query", "name": "overrideExceptions", "schema": { "default": false, "type": "boolean" }, "description": "If true, closes all open exceptions and approves the invoice. If false and exceptions exist, approval will fail." } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string", "description": "The ID of the invoice to approve (alternative to path parameter)" }, "overrideExceptions": { "default": false, "nullable": true, "title": "Boolean", "type": "boolean", "description": "If true, closes all open exceptions and approves the invoice" } }, "type": "object" } } }, "description": "Optional request body. Parameters can be provided either in the query string or request body.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "approveInvoice": { "nullable": false, "properties": { "error": { "nullable": true, "properties": { "code": { "nullable": false, "title": "String", "type": "string", "description": "Error code. OPEN_EXCEPTIONS: Invoice has unresolved exceptions (use overrideExceptions=true to force approval). INVOICE_NOT_FOUND: Invoice does not exist or is not in CREATED status." }, "message": { "nullable": false, "title": "String", "type": "string", "description": "Human-readable error message" } }, "title": "InvoiceErrorResponse", "type": "object", "description": "Error details if approval failed" }, "exceptions": { "items": { "nullable": false, "properties": { "createdAt": { "nullable": false, "title": "String", "type": "string", "description": "Timestamp when the exception was created", "format": "date-time" }, "id": { "nullable": false, "title": "String", "type": "string", "description": "Exception unique identifier" }, "ownerId": { "nullable": false, "title": "String", "type": "string", "description": "ID of the invoice this exception belongs to" }, "status": { "nullable": false, "title": "String", "type": "string", "description": "Current status of the exception" }, "type": { "nullable": false, "title": "String", "type": "string", "description": "Type of exception" }, "updatedAt": { "nullable": false, "title": "String", "type": "string", "description": "Timestamp when the exception was last updated", "format": "date-time" } }, "title": "InvoiceException", "type": "object", "description": "Exception details" }, "nullable": false, "type": "array", "description": "List of exceptions on the invoice. If overrideExceptions=true, these are the exceptions that were closed." }, "success": { "nullable": false, "title": "Boolean", "type": "boolean", "description": "Whether the approval was successful" } }, "title": "InvoiceApprovalResponse", "type": "object", "description": "The approval operation result" } }, "type": "object" } } }, "description": "Invoice approval response" } }, "tags": [ "Invoice Approval" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-customers": { "post": { "summary": "Create Many Customers", "description": "Create multiple customers at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/CustomersInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomers": { "description": "response of any mutation on the table \"customers\"", "nullable": true, "properties": { "returning": { "items": { "description": "columns and relationships of \"customers\"", "nullable": false, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CustomersMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-customers" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-carrier-invoices": { "post": { "summary": "Create Many Carrier Invoices", "description": "Create multiple carrier invoices at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/CarrierInvoicesInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCarrierInvoices": { "description": "response of any mutation on the table \"carrier_invoices\"", "nullable": true, "properties": { "returning": { "items": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": false, "properties": { "balance": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoiceLineItems": { "items": { "description": "columns and relationships of \"carrier_invoice_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoiceLineItems", "type": "object" }, "nullable": false, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoices", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CarrierInvoicesMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-carrier-invoices" } }, "tags": [ "Carrier Invoices" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoice_approval_requests": { "get": { "summary": "List carrier invoice approval requests", "description": "Retrieve a paginated list of carrier invoice approval requests with optional filtering and sorting.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceApprovalRequests": { "items": { "description": "Tracks carrier invoice approval requests with retry logic and state management", "nullable": false, "properties": { "carrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": false, "properties": { "carrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" } }, "title": "Carriers", "type": "object" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoices", "type": "object" }, "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "retryCount": { "nullable": false, "title": "Int", "type": "integer" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceApprovalRequestStatusEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoiceApprovalRequest", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/carrier_invoice_approval_requests" } }, "tags": [ "Carrier Invoice Approval Requests" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/carrier_invoice_approval_requests/{id}": { "get": { "summary": "Get carrier invoice approval request", "description": "Retrieve a single carrier invoice approval request by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "carrierInvoiceApprovalRequest": { "description": "Tracks carrier invoice approval requests with retry logic and state management", "nullable": true, "properties": { "carrierInvoice": { "description": "Invoices (payables) received from carriers (e.g. via email)", "nullable": false, "properties": { "carrier": { "description": "columns and relationships of \"carriers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" } }, "title": "Carriers", "type": "object" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CarrierInvoices", "type": "object" }, "carrierInvoiceId": { "nullable": false, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "retryCount": { "nullable": false, "title": "Int", "type": "integer" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceApprovalRequestStatusEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoiceApprovalRequest", "type": "object" } } } } }, "description": "Responses for GET /api/rest/carrier_invoice_approval_requests/{id}" } }, "tags": [ "Carrier Invoice Approval Requests" ], "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update Carrier Invoice Approval Request", "description": "Update a carrier invoice approval request status and response payload", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/CarrierInvoiceApprovalRequestSetInput", "properties": { "status": { "type": "string", "enum": [ "SUCCEEDED", "FAILED" ], "description": "The approval request status. Only SUCCEEDED or FAILED are allowed." }, "response_payload": { "type": "object", "description": "The response payload from the approval request" } } } }, "type": "object", "required": [ "input" ] } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updatedCarrierInvoiceApprovalRequest": { "description": "Tracks carrier invoice approval requests with retry logic and state management", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string", "description": "The approval request ID" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceApprovalRequestStatusEnum", "type": "string", "description": "The updated status" } }, "title": "CarrierInvoiceApprovalRequest", "type": "object" } } } } }, "description": "Successful response" } }, "tags": [ "Carrier Invoice Approval Requests" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payment_line_items": { "get": { "summary": "Get Many Customer Payment Line Items", "description": "Retrieve a list of customer payment line items", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPaymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/customer_payment_line_items" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Customer Payment Line Item", "description": "Create a new customer payment line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/PaymentLineItemsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomerPaymentLineItem": { "description": "columns and relationships of \"payment_line_items\"", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" } } } } }, "description": "Responses for POST /api/rest/customer_payment_line_items" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payment_line_items/search": { "post": { "summary": "Search Customer Payment Line Items", "description": "Search for customer payment line items based on specified criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "PaymentLineItemsOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"payment_line_items\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "checkDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "checkOrAchNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "customer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "customerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "exchangeRate": { "type": "object", "description": "StringComparisonExp (simplified)" }, "fees": { "type": "object", "description": "IntComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoice": { "type": "object", "description": "InvoicesBoolExp (simplified)" }, "invoiceId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "notes": { "type": "object", "description": "StringComparisonExp (simplified)" }, "payment": { "type": "object", "description": "PaymentsBoolExp (simplified)" }, "paymentId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "paymentMethodType": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "status": { "type": "object", "description": "StringComparisonExp (simplified)" }, "totalAmount": { "type": "object", "description": "IntComparisonExp (simplified)" }, "totalAmountWithFees": { "type": "object", "description": "IntComparisonExp (simplified)" }, "transactionDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" } }, "title": "PaymentLineItemsBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPaymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/customer_payment_line_items/search" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customer_payment_line_items/{id}": { "get": { "summary": "Get One Customer Payment Line Item", "description": "Retrieve details of a specific customer payment line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customerPaymentLineItem": { "description": "columns and relationships of \"payment_line_items\"", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" } } } } }, "description": "Responses for GET /api/rest/customer_payment_line_items/{id}" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Customer Payment Line Item", "description": "Update details of a specific customer payment line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/PaymentLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCustomerPaymentLineItem": { "description": "columns and relationships of \"payment_line_items\"", "nullable": true, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/customer_payment_line_items/{id}" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Customer Payment Line Item", "description": "Delete a specific customer payment line item", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCustomerPaymentLineItem": { "description": "columns and relationships of \"payment_line_items\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "PaymentLineItems", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/customer_payment_line_items/{id}" } }, "tags": [ "Customer Payment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bulk-customer-payments": { "post": { "summary": "Create Many Customer Payments", "description": "Create multiple customer payments at once", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "inputs": { "items": { "$ref": "#/components/schemas/PaymentsInsertInput" }, "nullable": false, "type": "array" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomerPayments": { "description": "response of any mutation on the table \"payments\"", "nullable": true, "properties": { "returning": { "items": { "description": "Payment records", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "paymentLineItems": { "items": { "description": "columns and relationships of \"payment_line_items\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": false, "title": "String", "type": "string" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "totalAmount": { "nullable": false, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Payments", "type": "object" }, "nullable": false, "type": "array" } }, "title": "PaymentsMutationResponse", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bulk-customer-payments" } }, "tags": [ "Customer Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customers": { "get": { "summary": "Get Many Customers", "description": "Query a list of customers", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customers": { "items": { "description": "columns and relationships of \"customers\"", "nullable": false, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" }, "nullable": false, "type": "array" }, "customersAggregate": { "description": "aggregated selection of \"customers\"", "nullable": false, "properties": { "aggregate": { "description": "aggregate fields of \"customers\"", "nullable": true, "properties": { "avg": { "description": "aggregate avg on columns", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CustomersAvgFields", "type": "object" }, "count": { "nullable": false, "title": "Int", "type": "integer" }, "sum": { "description": "aggregate sum on columns", "nullable": true, "properties": { "balance": { "$ref": "#/components/schemas/bigint" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "CustomersSumFields", "type": "object" } }, "title": "CustomersAggregateFields", "type": "object" } }, "title": "CustomersAggregate", "type": "object" } } } } }, "description": "Responses for GET /api/rest/customers" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Customer By Source System Id", "description": "Update a customer by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "customerRulesInput": { "default": {}, "description": "input type for updating data in table \"customer_rules\"", "nullable": true, "properties": { "autoSend": { "nullable": true, "title": "Boolean", "type": "boolean" }, "automationGoLiveDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customFilenameConfig": { "$ref": "#/components/schemas/jsonb" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "deliveryRules": { "nullable": true, "title": "String", "type": "string" }, "documentRules": { "$ref": "#/components/schemas/jsonb" }, "dueOption": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": true, "title": "String", "type": "string" }, "invoiceCreationEnabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "invoiceCreationMode": { "nullable": true, "title": "String", "type": "string" }, "invoiceCreationTrigger": { "nullable": true, "title": "String", "type": "string" }, "invoiceOrganizationTemplateId": { "nullable": true, "title": "String", "type": "string" }, "listBillColumnTemplateId": { "nullable": true, "title": "String", "type": "string" }, "organizationEmailTemplatesId": { "nullable": true, "title": "String", "type": "string" }, "outreachDelay": { "nullable": true, "title": "Int", "type": "integer" }, "outreachEmail": { "nullable": true, "title": "String", "type": "string" }, "postDeliveryInvoiceBufferDays": { "nullable": true, "title": "Int", "type": "integer" }, "referenceRules": { "$ref": "#/components/schemas/jsonb" }, "statementOrganizationEmailTemplatesId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CustomerRulesSetInput", "type": "object" }, "input": { "default": {}, "description": "input type for updating data in table \"customers\"", "nullable": true, "properties": { "addressesLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "billToCode": { "nullable": true, "title": "String", "type": "string" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "billToSource": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "collectorId": { "$ref": "#/components/schemas/uuid" }, "contactsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "credit": { "$ref": "#/components/schemas/jsonb" }, "deletedAt": { "$ref": "#/components/schemas/timestamp" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "isActive": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mergedIntoCustomerId": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentDiscountTerms": { "$ref": "#/components/schemas/jsonb" }, "reminderSequenceId": { "nullable": true, "title": "String", "type": "string" }, "reminderSettings": { "$ref": "#/components/schemas/jsonb" }, "remittanceSettings": { "$ref": "#/components/schemas/jsonb" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "tmsBalanceCents": { "$ref": "#/components/schemas/bigint" }, "tmsCustomerType": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CustomersSetInput", "type": "object" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCustomer": { "description": "response of any mutation on the table \"customers\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"customers\"", "nullable": false, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CustomersMutationResponse", "type": "object" }, "updateCustomerRules": { "description": "response of any mutation on the table \"customer_rules\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" } }, "title": "CustomerRulesMutationResponse", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/customers" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Customer", "description": "Create a new customer.\n\n**Integration note:** `POST` errors with `400 Uniqueness violation` if a customer with this `(sourceSystem, sourceSystemId)` pair already exists. Use `PUT /api/rest/customers/{id}` (or `PUT /api/rest/customers/by-source-system-id/{id}`) for updates. See [Integration patterns](/integration-patterns#idempotent-upserts-via-sourcesystem--sourcesystemid).", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CustomersInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createCustomer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" } } } } }, "description": "Responses for POST /api/rest/customers" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Customer By Source System Id", "description": "Delete a customer by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCustomer": { "description": "response of any mutation on the table \"customers\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"customers\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Customers", "type": "object" }, "nullable": false, "type": "array" } }, "title": "CustomersMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/customers" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customers/search": { "post": { "summary": "Search Customers", "description": "Search for customers based on specified criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "CustomersOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"customers\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "nullable": true, "type": "array" }, "addresses": { "type": "object", "description": "AddressesBoolExp (simplified)" }, "addressesAggregate": { "type": "object", "description": "AddressesAggregateBoolExp (simplified)" }, "addressesLastUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "balance": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "billToCode": { "type": "object", "description": "StringComparisonExp (simplified)" }, "billToCustomer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "billToCustomerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "billToSource": { "type": "object", "description": "StringComparisonExp (simplified)" }, "breakthroughFuelShippers": { "type": "object", "description": "CustomerIntegrationsMappingBoolExp (simplified)" }, "breakthroughFuelShippersAggregate": { "type": "object", "description": "CustomerIntegrationsMappingAggregateBoolExp (simplified)" }, "ccEmailAddresses": { "type": "object", "description": "StringArrayComparisonExp (simplified)" }, "childCustomers": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "childCustomersAggregate": { "type": "object", "description": "CustomersAggregateBoolExp (simplified)" }, "collector": { "type": "object", "description": "UsersBoolExp (simplified)" }, "collectorId": { "type": "object", "description": "UuidComparisonExp (simplified)" }, "computedCreditRating": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedCreditUsage": { "type": "object", "description": "IntComparisonExp (simplified)" }, "computedDeliveryMethod": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedInvoiceEmail": { "type": "object", "description": "StringComparisonExp (simplified)" }, "computedRemittanceEmail": { "type": "object", "description": "StringComparisonExp (simplified)" }, "contacts": { "type": "object", "description": "ContactsBoolExp (simplified)" }, "contactsAggregate": { "type": "object", "description": "ContactsAggregateBoolExp (simplified)" }, "contactsLastUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "credit": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "customerEmailSettings": { "type": "object", "description": "CustomerEmailSettingsBoolExp (simplified)" }, "customerEmailSettingsAggregate": { "type": "object", "description": "CustomerEmailSettingsAggregateBoolExp (simplified)" }, "customerIntegrationMappings": { "type": "object", "description": "CustomerIntegrationsMappingBoolExp (simplified)" }, "customerIntegrationMappingsAggregate": { "type": "object", "description": "CustomerIntegrationsMappingAggregateBoolExp (simplified)" }, "customerIntegrationSettings": { "type": "object", "description": "CustomerIntegrationSettingsBoolExp (simplified)" }, "customerIntegrationSettingsAggregate": { "type": "object", "description": "CustomerIntegrationSettingsAggregateBoolExp (simplified)" }, "customerRule": { "type": "object", "description": "CustomerRulesBoolExp (simplified)" }, "deletedAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "deliveryMethods": { "type": "object", "description": "DeliveryMethodsBoolExp (simplified)" }, "deliveryMethodsAggregate": { "type": "object", "description": "DeliveryMethodsAggregateBoolExp (simplified)" }, "deliveryRoutingRules": { "type": "object", "description": "DeliveryRoutingRulesBoolExp (simplified)" }, "deliveryRoutingRulesAggregate": { "type": "object", "description": "DeliveryRoutingRulesAggregateBoolExp (simplified)" }, "emailAddress": { "type": "object", "description": "StringComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoiceCreationTimetable": { "type": "object", "description": "InvoiceCreationEventsBoolExp (simplified)" }, "invoiceCreationTimetableAggregate": { "type": "object", "description": "InvoiceCreationEventsAggregateBoolExp (simplified)" }, "invoiceSplitRules": { "type": "object", "description": "InvoiceSplitRulesBoolExp (simplified)" }, "invoiceSplitRulesAggregate": { "type": "object", "description": "InvoiceSplitRulesAggregateBoolExp (simplified)" }, "invoices": { "type": "object", "description": "InvoicesBoolExp (simplified)" }, "invoicesAggregate": { "type": "object", "description": "InvoicesAggregateBoolExp (simplified)" }, "isActive": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "mergedIntoCustomer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "mergedIntoCustomerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "metadata": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "name": { "type": "object", "description": "StringComparisonExp (simplified)" }, "notes": { "type": "object", "description": "StringComparisonExp (simplified)" }, "onTimeRate": { "type": "object", "description": "NumericComparisonExp (simplified)" }, "overdueBalance": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "overdueInvoiceCount": { "type": "object", "description": "IntComparisonExp (simplified)" }, "paymentDiscountTerms": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsBoolExp (simplified)" }, "paymentLineItemsAggregate": { "type": "object", "description": "PaymentLineItemsAggregateBoolExp (simplified)" }, "reminderSequence": { "type": "object", "description": "ReminderSequencesBoolExp (simplified)" }, "reminderSequenceId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "reminderSettings": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "reminders": { "type": "object", "description": "RemindersBoolExp (simplified)" }, "remindersAggregate": { "type": "object", "description": "RemindersAggregateBoolExp (simplified)" }, "remittanceLineItems": { "type": "object", "description": "RemittanceLineItemsBoolExp (simplified)" }, "remittanceLineItemsAggregate": { "type": "object", "description": "RemittanceLineItemsAggregateBoolExp (simplified)" }, "remittanceSettings": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "remittances": { "type": "object", "description": "RemittancesBoolExp (simplified)" }, "remittancesAggregate": { "type": "object", "description": "RemittancesAggregateBoolExp (simplified)" }, "shipments": { "type": "object", "description": "ShipmentsBoolExp (simplified)" }, "shipmentsAggregate": { "type": "object", "description": "ShipmentsAggregateBoolExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "statementCreationTimetable": { "type": "object", "description": "StatementCreationEventsBoolExp (simplified)" }, "statementCreationTimetableAggregate": { "type": "object", "description": "StatementCreationEventsAggregateBoolExp (simplified)" }, "statementSchedules": { "type": "object", "description": "StatementSchedulesBoolExp (simplified)" }, "statementSchedulesAggregate": { "type": "object", "description": "StatementSchedulesAggregateBoolExp (simplified)" }, "statements": { "type": "object", "description": "StatementsBoolExp (simplified)" }, "statementsAggregate": { "type": "object", "description": "StatementsAggregateBoolExp (simplified)" }, "tmsBalanceCents": { "type": "object", "description": "BigintComparisonExp (simplified)" }, "tmsCustomerType": { "type": "object", "description": "StringComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" } }, "title": "CustomersBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customers": { "items": { "description": "columns and relationships of \"customers\"", "nullable": false, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/customers/search" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/customers/{id}": { "get": { "summary": "Get One Customer", "description": "Get a customer by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "customer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" } } } } }, "description": "Responses for GET /api/rest/customers/{id}" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Customer", "description": "Update a customer by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "customerRulesInput": { "default": {}, "description": "input type for updating data in table \"customer_rules\"", "nullable": true, "properties": { "autoSend": { "nullable": true, "title": "Boolean", "type": "boolean" }, "automationGoLiveDate": { "$ref": "#/components/schemas/date" }, "customFilenameConfig": { "$ref": "#/components/schemas/jsonb" }, "dueOption": { "nullable": true, "title": "Int", "type": "integer" }, "invoiceCreationEnabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "invoiceCreationMode": { "nullable": true, "title": "String", "type": "string" }, "invoiceOrganizationTemplateId": { "nullable": true, "title": "String", "type": "string" }, "listBillColumnTemplateId": { "nullable": true, "title": "String", "type": "string" }, "organizationEmailTemplatesId": { "nullable": true, "title": "String", "type": "string" }, "postDeliveryInvoiceBufferDays": { "nullable": true, "title": "Int", "type": "integer" }, "statementOrganizationEmailTemplatesId": { "nullable": true, "title": "String", "type": "string" } }, "title": "CustomerRulesSetInput", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "default": {}, "description": "input type for updating data in table \"customers\"", "nullable": true, "properties": { "addressesLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "billToCode": { "nullable": true, "title": "String", "type": "string" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "billToSource": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "collectorId": { "$ref": "#/components/schemas/uuid" }, "contactsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamp" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "isActive": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mergedIntoCustomerId": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "paymentDiscountTerms": { "$ref": "#/components/schemas/jsonb" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "tmsBalanceCents": { "$ref": "#/components/schemas/bigint" }, "tmsCustomerType": { "nullable": true, "title": "String", "type": "string" } }, "title": "CustomersSetInput", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateCustomer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "addresses": { "items": { "description": "columns and relationships of \"addresses\"", "nullable": false, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "nullable": false, "type": "array" }, "balance": { "$ref": "#/components/schemas/bigint" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerRule": { "description": "columns and relationships of \"customer_rules\"", "nullable": true, "properties": { "dueOption": { "nullable": false, "title": "Int", "type": "integer" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "CustomerRules", "type": "object" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "overdueBalance": { "$ref": "#/components/schemas/bigint" }, "overdueInvoiceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "Customers", "type": "object" }, "updateCustomerRules": { "description": "response of any mutation on the table \"customer_rules\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" } }, "title": "CustomerRulesMutationResponse", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/customers/{id}" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Customer", "description": "Delete a customer by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteCustomer": { "description": "columns and relationships of \"customers\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Customers", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/customers/{id}" } }, "tags": [ "Customers" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipment_line_items": { "post": { "summary": "Create One Shipment Line Item", "description": "Create One Shipment Line Item***\nThe GraphQl query for this endpoint is:\n``` graphql\nmutation CreateOneShipmentLineItem ($input: ShipmentLineItemsInsertInput!) {\n createShipmentLineItem: insertShipmentLineItemsOne(object: $input) {\n id\n shipmentId\n lineNumber\n commodityDescription\n packageQty\n packageType\n packageUnit\n handlingUnit\n handlingUnitQty\n handlingUnitType\n weight\n weightUnit\n weightUnitType\n nmfcClass\n nmfcNumber\n hazmatFlag\n length\n width\n height\n dimensionUnit\n freightClass\n pickupLocationName\n deliveryLocationName\n referenceNumber\n sourceSystem\n sourceSystemId\n createdAt\n updatedAt\n }\n}\n\n```", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/ShipmentLineItemsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createShipmentLineItem": { "description": "Shipment Line Items", "nullable": true, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" } } } } }, "description": "Responses for POST /api/rest/shipment_line_items" } }, "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipment_line_items/search": { "post": { "summary": "Search Shipment Line Items", "description": "Search for shipment line items by source system and source system ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/shipment_line_items/search" } }, "tags": [ "Shipment Line Items" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipment_line_items/{id}": { "get": { "summary": "Get One Shipment Line Item", "description": "Get One Shipment Line Item***\nThe GraphQl query for this endpoint is:\n``` graphql\nquery ShipmentLineItem ($id: String!) {\n shipmentLineItem: shipmentLineItemsByPk(id: $id) {\n id\n shipmentId\n lineNumber\n commodityDescription\n packageQty\n packageType\n packageUnit\n handlingUnit\n handlingUnitQty\n handlingUnitType\n weight\n weightUnit\n weightUnitType\n nmfcClass\n nmfcNumber\n hazmatFlag\n length\n width\n height\n dimensionUnit\n freightClass\n pickupLocationName\n deliveryLocationName\n referenceNumber\n sourceSystem\n sourceSystemId\n createdAt\n updatedAt\n }\n}\n\n```", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipmentLineItem": { "description": "Shipment Line Items", "nullable": true, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" } } } } }, "description": "Responses for GET /api/rest/shipment_line_items/{id}" } }, "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Shipment Line Item", "description": "Delete One Shipment Line Item***\nThe GraphQl query for this endpoint is:\n``` graphql\nmutation DeleteOneShipmentLineItem ($id: String!) {\n deleteShipmentLineItem: deleteShipmentLineItemsByPk(id: $id) {\n id\n }\n}\n\n```", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteShipmentLineItem": { "description": "Shipment Line Items", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "ShipmentLineItems", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/shipment_line_items/{id}" } }, "x-mint": { "metadata": { "public": true } } }, "patch": { "summary": "Update One Shipment Line Item", "description": "Update One Shipment Line Item***\nThe GraphQl query for this endpoint is:\n``` graphql\nmutation UpdateOneShipmentLineItem ($id: String!, $input: ShipmentLineItemsSetInput!) {\n updateShipmentLineItem: updateShipmentLineItemsByPk(pkColumns: {id: $id}, _set: $input) {\n id\n shipmentId\n lineNumber\n commodityDescription\n packageQty\n packageType\n packageUnit\n handlingUnit\n handlingUnitQty\n handlingUnitType\n weight\n weightUnit\n weightUnitType\n nmfcClass\n nmfcNumber\n hazmatFlag\n length\n width\n height\n dimensionUnit\n freightClass\n pickupLocationName\n deliveryLocationName\n referenceNumber\n sourceSystem\n sourceSystemId\n createdAt\n updatedAt\n }\n}\n\n```", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/ShipmentLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateShipmentLineItem": { "description": "Shipment Line Items", "nullable": true, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/shipment_line_items/{id}" } }, "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipments": { "get": { "summary": "Get Many Shipments", "description": "Query a list of shipments", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipments": { "items": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/shipments" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Shipment By Source System Id", "description": "Update a shipment by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/ShipmentsSetInput" }, "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateShipment": { "description": "response of any mutation on the table \"shipments\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" }, "nullable": false, "type": "array" } }, "title": "ShipmentsMutationResponse", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/shipments" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create One Shipment", "description": "Create a new shipment.\n\n**Integration notes:**\n- `POST` errors with `400 Uniqueness violation` on duplicate `(sourceSystem, sourceSystemId)`. Use `PUT` for updates.\n- `shipmentId` is `NOT NULL` with no server-side default — you must provide a unique string.\n- `customerTotalRate` and `carrierTotalRate` are integer cents, not float dollars.\n\nSee [Integration patterns](/integration-patterns).", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/ShipmentsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createShipment": { "description": "columns and relationships of \"shipments\"", "nullable": true, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } } } } }, "description": "Responses for POST /api/rest/shipments" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Shipment By Source System Id", "description": "Delete a shipment by source system id", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteShipment": { "description": "response of any mutation on the table \"shipments\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" }, "nullable": false, "type": "array" } }, "title": "ShipmentsMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/shipments" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipments/search": { "post": { "summary": "Search Shipments", "description": "Search for shipments based on specified criteria", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "limit": { "default": 10, "nullable": true, "title": "Int", "type": "integer" }, "offset": { "default": 0, "nullable": true, "title": "Int", "type": "integer" }, "orderBy": { "default": {}, "items": { "type": "object", "description": "ShipmentsOrderBy (simplified)" }, "nullable": true, "type": "array" }, "where": { "default": {}, "description": "Boolean expression to filter rows from the table \"shipments\". All fields are combined with a logical 'AND'.", "nullable": true, "properties": { "_and": { "items": { "type": "object", "description": "ShipmentsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "_not": { "type": "object", "description": "ShipmentsBoolExp (simplified)" }, "_or": { "items": { "type": "object", "description": "ShipmentsBoolExp (simplified)" }, "nullable": true, "type": "array" }, "billOfLadingNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "billedDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "billedMiles": { "type": "object", "description": "NumericComparisonExp (simplified)" }, "bills": { "type": "object", "description": "BillsBoolExp (simplified)" }, "billsAggregate": { "type": "object", "description": "BillsAggregateBoolExp (simplified)" }, "carrier": { "type": "object", "description": "CarriersBoolExp (simplified)" }, "carrierDocumentRequests": { "type": "object", "description": "CarrierDocumentRequestsBoolExp (simplified)" }, "carrierDocumentRequestsAggregate": { "type": "object", "description": "CarrierDocumentRequestsAggregateBoolExp (simplified)" }, "carrierId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "carrierInvoices": { "type": "object", "description": "CarrierInvoicesBoolExp (simplified)" }, "carrierInvoicesAggregate": { "type": "object", "description": "CarrierInvoicesAggregateBoolExp (simplified)" }, "carrierProNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "carrierTotalRate": { "type": "object", "description": "IntComparisonExp (simplified)" }, "company": { "type": "object", "description": "CompaniesBoolExp (simplified)" }, "companyId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "consigneeAddress": { "type": "object", "description": "AddressesBoolExp (simplified)" }, "consigneeAddressId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "consigneeAddressOld": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "coveredDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "createdAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "createdFromEmailMessageId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "currency": { "type": "object", "description": "CurrencyCodeEnumComparisonExp (simplified)" }, "currencyCode": { "type": "object", "description": "CurrencyCodeBoolExp (simplified)" }, "customer": { "type": "object", "description": "CustomersBoolExp (simplified)" }, "customerId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "customerMiles": { "type": "object", "description": "NumericComparisonExp (simplified)" }, "customerPoNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "customerReferenceNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "customerTotalRate": { "type": "object", "description": "IntComparisonExp (simplified)" }, "declaredValue": { "type": "object", "description": "IntComparisonExp (simplified)" }, "deliveredAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "dispatchedDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "dispatcherEmail": { "type": "object", "description": "StringComparisonExp (simplified)" }, "dispatcherName": { "type": "object", "description": "StringComparisonExp (simplified)" }, "dispatcherPhone": { "type": "object", "description": "StringComparisonExp (simplified)" }, "documentsCustomerVisibilityUpdatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "emailActivities": { "type": "object", "description": "EmailActivitiesBoolExp (simplified)" }, "emailActivitiesAggregate": { "type": "object", "description": "EmailActivitiesAggregateBoolExp (simplified)" }, "equipment": { "type": "object", "description": "StringComparisonExp (simplified)" }, "fileAssociations": { "type": "object", "description": "FileAssociationsBoolExp (simplified)" }, "fileAssociationsAggregate": { "type": "object", "description": "FileAssociationsAggregateBoolExp (simplified)" }, "freightChargeTerm": { "type": "object", "description": "FreightChargeTermEnumComparisonExp (simplified)" }, "freightChargeTermInfo": { "type": "object", "description": "FreightChargeTermBoolExp (simplified)" }, "freightClass": { "type": "object", "description": "StringComparisonExp (simplified)" }, "holdReason": { "type": "object", "description": "StringComparisonExp (simplified)" }, "id": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoiceCreationEvent": { "type": "object", "description": "InvoiceCreationEventsBoolExp (simplified)" }, "invoiceCreationEventId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "invoiceId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "lengthInFeet": { "type": "object", "description": "IntComparisonExp (simplified)" }, "loadDescription": { "type": "object", "description": "StringComparisonExp (simplified)" }, "loadedDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "mode": { "type": "object", "description": "StringComparisonExp (simplified)" }, "movementType": { "type": "object", "description": "StringComparisonExp (simplified)" }, "notes": { "type": "object", "description": "NotesBoolExp (simplified)" }, "notesAggregate": { "type": "object", "description": "NotesAggregateBoolExp (simplified)" }, "onHold": { "type": "object", "description": "BooleanComparisonExp (simplified)" }, "pickupAddress": { "type": "object", "description": "AddressesBoolExp (simplified)" }, "pickupAddressId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "pickupAddressOld": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "pickupAt": { "type": "object", "description": "TimestampComparisonExp (simplified)" }, "readyDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "referenceNumbers": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "releaseDate": { "type": "object", "description": "DateComparisonExp (simplified)" }, "serviceLevel": { "type": "object", "description": "StringComparisonExp (simplified)" }, "shipmentId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "shipmentIdInt": { "type": "object", "description": "IntComparisonExp (simplified)" }, "shipmentInvoices": { "type": "object", "description": "InvoiceShipmentsBoolExp (simplified)" }, "shipmentInvoicesAggregate": { "type": "object", "description": "InvoiceShipmentsAggregateBoolExp (simplified)" }, "shipmentLineItems": { "type": "object", "description": "ShipmentLineItemsBoolExp (simplified)" }, "shipmentLineItemsAggregate": { "type": "object", "description": "ShipmentLineItemsAggregateBoolExp (simplified)" }, "signedBy": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystem": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemId": { "type": "object", "description": "StringComparisonExp (simplified)" }, "sourceSystemMeta": { "type": "object", "description": "JsonbComparisonExp (simplified)" }, "specialInstructions": { "type": "object", "description": "StringComparisonExp (simplified)" }, "status": { "type": "object", "description": "StringComparisonExp (simplified)" }, "stops": { "type": "object", "description": "StopsBoolExp (simplified)" }, "stopsAggregate": { "type": "object", "description": "StopsAggregateBoolExp (simplified)" }, "terminal": { "type": "object", "description": "StringComparisonExp (simplified)" }, "trailerNumber": { "type": "object", "description": "StringComparisonExp (simplified)" }, "truckMiles": { "type": "object", "description": "NumericComparisonExp (simplified)" }, "updatedAt": { "type": "object", "description": "TimestamptzComparisonExp (simplified)" }, "volume": { "type": "object", "description": "Float8ComparisonExp (simplified)" }, "volumeUnit": { "type": "object", "description": "StringComparisonExp (simplified)" }, "weight": { "type": "object", "description": "Float8ComparisonExp (simplified)" }, "weightUnit": { "type": "object", "description": "StringComparisonExp (simplified)" } }, "title": "ShipmentsBoolExp", "type": "object" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipments": { "items": { "description": "columns and relationships of \"shipments\"", "nullable": false, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/shipments/search" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipments/{id}": { "get": { "summary": "Get One Shipment", "description": "Get a shipment by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipment": { "description": "columns and relationships of \"shipments\"", "nullable": true, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } } } } }, "description": "Responses for GET /api/rest/shipments/{id}" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update One Shipment", "description": "Update a shipment by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/ShipmentsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateShipment": { "description": "columns and relationships of \"shipments\"", "nullable": true, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "description": "Companies table - stores all company entities with their branding, contact info, and MC numbers. Each tenant can have multiple companies for different divisions or legal entities.", "nullable": true, "properties": { "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": false, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "Companies", "type": "object" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "pickupAddress": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "shipmentInvoices": { "items": { "description": "columns and relationships of \"invoice_shipments\"", "nullable": false, "properties": { "invoice": { "description": "columns and relationships of \"invoices\"", "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "Invoices", "type": "object" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "title": "InvoiceShipments", "type": "object" }, "nullable": false, "type": "array" }, "shipmentLineItems": { "items": { "description": "Shipment Line Items", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": false, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": false, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "items": { "description": "columns and relationships of \"stops\"", "nullable": false, "properties": { "address": { "description": "columns and relationships of \"addresses\"", "nullable": true, "properties": { "city": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "id": { "nullable": false, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "Addresses", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Stops", "type": "object" }, "nullable": false, "type": "array" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/shipments/{id}" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete One Shipment", "description": "Delete a shipment by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteShipment": { "description": "columns and relationships of \"shipments\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "Shipments", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/shipments/{id}" } }, "tags": [ "Shipments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipments/{shipmentId}/documents": { "get": { "summary": "Get Many Shipment Documents", "description": "Query a list of shipment documents", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"shipmentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "shipmentId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "shipmentDocumentsByShipmentId": { "items": { "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/DateTime" }, "documentId": { "nullable": true, "title": "String", "type": "string" }, "documents": { "items": { "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": false, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": false, "title": "Boolean", "type": "boolean" } }, "title": "Document", "type": "object" }, "nullable": false, "type": "array" }, "file": { "nullable": false, "properties": { "filename": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" }, "url": { "nullable": false, "title": "String", "type": "string" } }, "title": "File", "type": "object" }, "id": { "nullable": false, "title": "String", "type": "string" }, "shipment": { "nullable": false, "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "number": { "nullable": false, "title": "String", "type": "string" } }, "title": "ShipmentInfo", "type": "object" }, "updatedAt": { "$ref": "#/components/schemas/DateTime" } }, "title": "ShipmentDocument", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/shipments/{shipmentId}/documents" } }, "tags": [ "Shipment Documents" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create Shipment Document", "description": "Create a new shipment document", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"shipmentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "shipmentId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/CreateShipmentDocumentInput" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createShipmentDocument": { "nullable": false, "properties": { "documentId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "ShipmentDocument", "type": "object" } } } } }, "description": "Responses for POST /api/rest/shipments/{shipmentId}/documents" } }, "tags": [ "Shipment Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/shipments/{shipmentId}/documents/{id}": { "delete": { "summary": "Delete Shipment Document", "description": "Delete a shipment document by ID", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true }, { "description": "_\"shipmentId\" is required (enter it either in parameters or request body)_", "in": "path", "name": "shipmentId", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "shipmentId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteFileAssociations": { "description": "response of any mutation on the table \"file_associations\"", "nullable": true, "properties": { "affectedRows": { "nullable": false, "title": "Int", "type": "integer" }, "returning": { "items": { "description": "Relationships for files", "nullable": false, "properties": { "associationId": { "nullable": false, "title": "String", "type": "string" }, "fileId": { "nullable": false, "title": "String", "type": "string" }, "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "FileAssociations", "type": "object" }, "nullable": false, "type": "array" } }, "title": "FileAssociationsMutationResponse", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/shipments/{shipmentId}/documents/{id}" } }, "tags": [ "Shipment Documents" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bill-payments": { "get": { "summary": "List bill payments", "description": "Retrieve a paginated list of bill payments with optional filtering and sorting.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 10, "type": "integer" } }, { "in": "query", "name": "offset", "schema": { "default": 0, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "billPayments": { "items": { "description": "columns and relationships of \"bill_payments\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPayments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for GET /api/rest/bill-payments" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } }, "post": { "summary": "Create bill payment", "description": "Create a new bill payment record.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "input": { "$ref": "#/components/schemas/BillPaymentsInsertInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "createBillPayment": { "description": "columns and relationships of \"bill_payments\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPayments", "type": "object" } } } } }, "description": "Responses for POST /api/rest/bill-payments" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bill-payments/search": { "post": { "summary": "Search bill payments", "description": "Search for bill payments by source system and source system ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"sourceSystem\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystem", "schema": { "type": "string" } }, { "description": "_\"sourceSystemId\" is required (enter it either in parameters or request body)_", "in": "query", "name": "sourceSystemId", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "sourceSystem": { "nullable": false, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "billPayments": { "items": { "description": "columns and relationships of \"bill_payments\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPayments", "type": "object" }, "nullable": false, "type": "array" } } } } }, "description": "Responses for POST /api/rest/bill-payments/search" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/bill-payments/{id}": { "get": { "summary": "Get bill payment", "description": "Retrieve a single bill payment by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "billPayment": { "description": "columns and relationships of \"bill_payments\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPayments", "type": "object" } } } } }, "description": "Responses for GET /api/rest/bill-payments/{id}" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } }, "put": { "summary": "Update bill payment", "description": "Update an existing bill payment by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/BillPaymentsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updateBillPayment": { "description": "columns and relationships of \"bill_payments\"", "nullable": true, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "items": { "description": "columns and relationships of \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": false, "title": "Int", "type": "integer" }, "billId": { "nullable": false, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItems", "type": "object" }, "nullable": false, "type": "array" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPayments", "type": "object" } } } } }, "description": "Responses for PUT /api/rest/bill-payments/{id}" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } }, "delete": { "summary": "Delete bill payment", "description": "Delete a bill payment by its ID.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "deleteBillPayment": { "description": "columns and relationships of \"bill_payments\"", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "BillPayments", "type": "object" } } } } }, "description": "Responses for DELETE /api/rest/bill-payments/{id}" } }, "tags": [ "Bill Payments" ], "x-mint": { "metadata": { "public": true } } } }, "/api/rest/purchase-order-line-items/{id}": { "patch": { "summary": "Update One Purchase Order Line Item", "description": "Update parsed purchase order line item fields. Body: `{ \"input\": { ...fields to set... } }` using the record's camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.", "parameters": [ { "description": "Your API key will be used for authentication of the request. `Authorization: YOUR_API_KEY`", "in": "header", "name": "authorization", "schema": { "type": "string" } }, { "description": "_\"id\" is required (enter it either in parameters or request body)_", "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "id": { "nullable": false, "title": "String", "type": "string" }, "input": { "$ref": "#/components/schemas/SupportingDocsPurchaseOrderLineItemsSetInput" } }, "type": "object" } } }, "description": "Query parameters can also be provided in the request body as a JSON object", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "updatePurchaseOrderLineItem": { "description": "Purchase Order line items (EDI 850 PO1-loop-shaped)", "nullable": true, "properties": { "id": { "nullable": false, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItems", "type": "object" } } } } }, "description": "Responses for PATCH /api/rest/purchase-order-line-items/{id}" } }, "tags": [ "Purchase Orders" ], "x-mint": { "metadata": { "public": true } } } } }, "components": { "schemas": { "timestamptz": { "nullable": false, "title": "timestamptz", "type": "string", "format": "date-time", "description": "A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00" }, "BillPaymentLineItemsInsertInput": { "description": "input type for inserting data into table \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": true, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "billPaymentId": { "nullable": true, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItemsInsertInput", "type": "object" }, "BillPaymentLineItemsSetInput": { "description": "input type for updating data in table \"bill_payment_line_items\"", "nullable": false, "properties": { "amount": { "nullable": true, "title": "Int", "type": "integer" }, "billId": { "nullable": true, "title": "String", "type": "string" }, "billPaymentId": { "nullable": true, "title": "String", "type": "string" }, "billingAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "billingName": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentLineItemsSetInput", "type": "object" }, "VendorsInsertInput": { "description": "input type for inserting data into table \"vendors\"", "nullable": false, "properties": { "name": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" } }, "title": "VendorsInsertInput", "type": "object" }, "jsonb": { "nullable": false, "title": "jsonb" }, "VendorsSetInput": { "description": "input type for updating data in table \"vendors\"", "nullable": false, "properties": { "name": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" } }, "title": "VendorsSetInput", "type": "object" }, "InvoiceLineItemsInsertInput": { "description": "input type for inserting data into table \"invoice_line_items\"", "nullable": false, "properties": { "accessorialCode": { "$ref": "#/components/schemas/EdiAccessorialCodesEnum" }, "description": { "nullable": true, "title": "String", "type": "string" }, "invoiceId": { "nullable": false, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "InvoiceLineItemsInsertInput", "type": "object" }, "EdiAccessorialCodesEnum": { "enum": [ "AAA", "AAJ", "AAM", "AAN", "AAO", "AAS", "AAT", "ABC", "ABL", "ACD", "ACF", "ACH", "ACL", "ACS", "ADH", "ADL", "ADV", "AFB", "AFC", "AGS", "AIB", "AIC", "AIR", "ALC", "ALP", "AMB", "AMC", "AMP", "ANB", "ANC", "ANS", "APL", "APT", "ARB", "ARC", "ARG", "ARR", "ASC", "AUX", "AVA", "BAA", "BAB", "BAC", "BAD", "BAF", "BAP", "BAS", "BBK", "BDX", "BEY", "BFD", "BKA", "BLA", "BLC", "BLD", "BLK", "BLW", "BND", "BOB", "BOP", "BRA", "BRD", "BRG", "BSC", "BSS", "BTC", "BU2", "BU4", "BUA", "BUR", "BYD", "CA1", "CA2", "CA4", "CAA", "CAC", "CAD", "CAE", "CAF", "CAG", "CAH", "CAJ", "CAK", "CAL", "CAO", "CAP", "CAQ", "CAR", "CAS", "CAV", "CAW", "CAZ", "CBL", "CBO", "CBP", "CBR", "CBW", "CBX", "CCA", "CCH", "CCP", "CCR", "CCS", "CDA", "CDD", "CDF", "CDR", "CER", "CFC", "CFL", "CGC", "CGL", "CGR", "CGT", "CHE", "CHG", "CHN", "CIR", "CIS", "CLC", "CLD", "CLN", "CLS", "CMC", "CMF", "CMI", "CMP", "CNS", "CNV", "COA", "COC", "COD", "COF", "COL", "COM", "CON", "COP", "COR", "COU", "CPA", "CPC", "CPE", "CPP", "CRA", "CRF", "CRP", "CRR", "CRS", "CSA", "CSC", "CSE", "CSF", "CSP", "CSR", "CST", "CTA", "CTC", "CTD", "CTE", "CTF", "CTG", "CTL", "CTO", "CTR", "CTX", "CUA", "CUD", "CUF", "CUP", "CUS", "DAA", "DAB", "DAC", "DAD", "DAM", "DBD", "DBL", "DBP", "DCE", "DCS", "DCT", "DCV", "DDA", "DDC", "DDD", "DDF", "DDN", "DDP", "DDS", "DDZ", "DEA", "DED", "DEL", "DEM", "DEP", "DER", "DES", "DET", "DEV", "DEW", "DEZ", "DFD", "DFM", "DFS", "DFW", "DGE", "DGS", "DIC", "DIR", "DIS", "DIV", "DLH", "DLP", "DMC", "DMD", "DNA", "DOC", "DON", "DOV", "DPB", "DPD", "DPE", "DPL", "DPR", "DPT", "DPU", "DRC", "DRP", "DRV", "DRY", "DSC", "DSF", "DSM", "DSR", "DST", "DTA", "DTB", "DTC", "DTD", "DTF", "DTL", "DTP", "DTU", "DTV", "DWC", "DWP", "EAC", "EAX", "EBD", "EBP", "ECC", "ECR", "ECS", "EDD", "EDO", "EEA", "EEB", "EEC", "EEF", "EEG", "EEH", "EEP", "EEX", "EIC", "ELS", "EMR", "EMS", "EMT", "ENC", "ENS", "EPC", "EPS", "ERS", "ERT", "ESA", "ESC", "ESD", "ESE", "ETR", "EUC", "EVC", "EXC", "EXD", "EXL", "EXM", "EXP", "EXS", "EXW", "EXZ", "FAB", "FAC", "FAD", "FAE", "FAF", "FAG", "FAH", "FAK", "FBD", "FCB", "FCD", "FCI", "FCS", "FDL", "FDS", "FFC", "FFI", "FFL", "FFN", "FFP", "FFR", "FFS", "FIR", "FLS", "FLT", "FMR", "FMS", "FRC", "FTC", "FTR", "FUE", "FWA", "FWC", "FXE", "GAR", "GAT", "GDR", "GGA", "GGF", "GKT", "GMS", "GOC", "GPD", "GRD", "GRS", "GSP", "GSS", "GST", "HAN", "HAZ", "HBD", "HDF", "HDG", "HDH", "HDW", "HET", "HFA", "HHA", "HHB", "HHG", "HIC", "HLF", "HMA", "HMI", "HOC", "HOL", "HOS", "HOX", "HRS", "HSC", "HUL", "HZC", "HZD", "HZS", "IAA", "IAB", "IAC", "ICE", "IDC", "IDD", "IDL", "IDP", "IFC", "IHT", "IIA", "IIH", "IIP", "IIU", "ILD", "ILF", "ILP", "IMP", "IMS", "INC", "INP", "INR", "INS", "INT", "IPC", "IPU", "IRA", "ISD", "ISO", "IST", "ITC", "ITS", "JST", "KIT", "LAA", "LAB", "LAC", "LAD", "LAE", "LAL", "LAT", "LAY", "LBR", "LC2", "LC4", "LCG", "LCL", "LCR", "LDA", "LDG", "LDL", "LDS", "LEC", "LFC", "LFD", "LFT", "LGD", "LHS", "LID", "LIE", "LLB", "LLC", "LLD", "LLF", "LLS", "LMC", "LMD", "LME", "LNT", "LOA", "LOC", "LPC", "LPD", "LPF", "LQD", "LSC", "LSH", "LSS", "LTC", "LTE", "LUB", "LUP", "LUS", "LYC", "MAA", "MAB", "MAC", "MAD", "MAE", "MAR", "MAT", "MCC", "MDG", "MDM", "MEA", "MEN", "MES", "MET", "MFC", "MFG", "MGA", "MGC", "MIC", "MIL", "MIN", "MKU", "MLB", "MLS", "MMC", "MMF", "MMS", "MMT", "MNC", "MNS", "MPC", "MRK", "MRP", "MSC", "MSG", "MTR", "MUS", "MVR", "MVS", "MVT", "NAA", "NAB", "NAL", "NCH", "NDS", "NFY", "NHB", "NSD", "NUM_002", "NUM_003", "NUM_004", "NUM_005", "NUM_006", "NUM_007", "NUM_008", "NUM_009", "NUM_010", "NUM_011", "NUM_012", "NUM_015", "NUM_016", "NUM_017", "NUM_020", "NUM_025", "NUM_026", "NUM_027", "NUM_028", "NUM_029", "NUM_030", "NUM_031", "NUM_032", "NUM_035", "NUM_040", "NUM_045", "NUM_050", "NUM_055", "NUM_060", "NUM_065", "NUM_070", "NUM_075", "NUM_080", "NUM_085", "NUM_090", "NUM_095", "NUM_100", "NUM_105", "NUM_110", "NUM_115", "NUM_120", "NUM_135", "NUM_140", "NUM_145", "NUM_150", "NUM_155", "NUM_160", "NUM_165", "NUM_170", "NUM_175", "NUM_180", "NUM_185", "NUM_186", "NUM_190", "NUM_205", "NUM_210", "NUM_215", "NUM_220", "NUM_225", "NUM_230", "NUM_235", "NUM_240", "NUM_245", "NUM_250", "NUM_255", "NUM_260", "NUM_265", "NUM_270", "NUM_275", "NUM_280", "NUM_285", "NUM_290", "NUM_295", "NUM_297", "NUM_300", "NUM_310", "NUM_315", "NUM_320", "NUM_325", "NUM_335", "NUM_340", "NUM_345", "NUM_350", "NUM_355", "NUM_360", "NUM_365", "NUM_370", "NUM_375", "NUM_380", "NUM_385", "NUM_390", "NUM_392", "NUM_393", "NUM_395", "NUM_400", "NUM_405", "NUM_410", "NUM_415", "NUM_416", "NUM_420", "NUM_425", "NUM_426", "NUM_430", "NUM_435", "NUM_440", "NUM_445", "NUM_450", "NUM_455", "NUM_460", "NUM_462", "NUM_465", "NUM_470", "NUM_475", "NUM_480", "NUM_485", "NUM_490", "NUM_495", "NUM_500", "NUM_505", "NUM_510", "NUM_515", "NUM_520", "NUM_525", "NUM_535", "NUM_540", "NUM_545", "NUM_550", "NUM_555", "NUM_560", "NUM_565", "NUM_570", "NUM_580", "NUM_585", "NUM_586", "NUM_590", "NUM_593", "NUM_595", "NUM_600", "NUM_605", "NUM_610", "NUM_615", "NUM_620", "NUM_625", "NUM_635", "NUM_640", "NUM_641", "NUM_645", "NUM_650", "NUM_665", "NUM_670", "NUM_675", "NUM_680", "NUM_685", "NUM_690", "NUM_695", "NUM_696", "NUM_697", "NUM_700", "NUM_705", "NUM_706", "NUM_720", "NUM_725", "NUM_730", "NUM_731", "NUM_732", "NUM_735", "NUM_736", "NUM_740", "NUM_745", "NUM_750", "NUM_760", "NUM_761", "NUM_762", "NUM_999", "NWD", "NYD", "NYP", "OAA", "OAB", "OAC", "OCH", "OCN", "ODF", "OFR", "OFU", "ONC", "OOC", "OOD", "OOF", "OPC", "ORC", "ORM", "OSC", "OSO", "OSS", "OUT", "OVR", "OWC", "PAA", "PAC", "PAD", "PAE", "PAF", "PAG", "PAH", "PAI", "PAJ", "PAK", "PAL", "PAR", "PAT", "PAV", "PBA", "PBE", "PBL", "PCH", "PCT", "PDB", "PDC", "PDS", "PDY", "PEC", "PEN", "PER", "PFA", "PHC", "PHG", "PIR", "PKS", "PLC", "PLT", "PMC", "PMR", "PMS", "PMT", "PMU", "PMX", "PNA", "POC", "POD", "POL", "POS", "PPC", "PPD", "PPH", "PPI", "PPM", "PPN", "PPO", "PPR", "PPS", "PPT", "PPU", "PRB", "PRC", "PRE", "PRK", "PRL", "PRM", "PRP", "PRS", "PRV", "PSC", "PSD", "PSG", "PSH", "PSS", "PST", "PTC", "PTS", "PUC", "PUD", "PUK", "PVB", "PVD", "PVI", "PVL", "PVP", "PVS", "PVT", "PWH", "PWT", "PYS", "QAA", "QQD", "RAA", "RAB", "RAC", "RAD", "RAE", "RAF", "RAG", "RAH", "RAI", "RAJ", "RAK", "RAL", "RAM", "RCA", "RCB", "RCC", "RCD", "RCE", "RCG", "RCL", "RCP", "RCS", "RDC", "RDF", "RDH", "REC", "REE", "REF", "REG", "REL", "REP", "REQ", "RES", "RET", "RFD", "RFM", "RGA", "RGC", "RHM", "RID", "RIE", "RLA", "RLC", "RLQ", "RLS", "RMB", "RMC", "RMD", "RMP", "RMS", "ROC", "RPC", "RPD", "RRC", "RRD", "RRF", "RRN", "RRP", "RRR", "RSM", "RSP", "RSS", "RST", "RSV", "RTC", "SAA", "SAB", "SAC", "SAD", "SAE", "SAF", "SAG", "SAH", "SAI", "SAJ", "SAK", "SAM", "SAN", "SAP", "SAS", "SAT", "SBC", "SBL", "SCC", "SCD", "SCG", "SCL", "SCU", "SDC", "SDL", "SDS", "SEC", "SEE", "SEG", "SEL", "SEQ", "SER", "SEV", "SFB", "SFC", "SFD", "SFE", "SFT", "SGL", "SHH", "SHL", "SHS", "SHW", "SKT", "SLC", "SLP", "SMS", "SNS", "SNT", "SOC", "SOP", "SPA", "SPB", "SPC", "SPD", "SPL", "SPP", "SPS", "SPT", "SPU", "SRG", "SRS", "SSA", "SSB", "SSC", "SSF", "SSL", "SSO", "SSP", "SSS", "SST", "SSU", "SSX", "STA", "STC", "STD", "STF", "STL", "STM", "STO", "STP", "STQ", "STR", "STW", "SUC", "SUF", "SUP", "SUR", "SVA", "SVL", "SVS", "SWC", "TAA", "TAB", "TAC", "TAD", "TAE", "TAF", "TAG", "TAH", "TAI", "TAJ", "TAK", "TAL", "TAR", "TAX", "TAY", "TCB", "TCM", "TDT", "TER", "TLC", "TMS", "TMV", "TOA", "TOC", "TPA", "TPC", "TPS", "TRA", "TRC", "TRE", "TRF", "TRM", "TRN", "TRP", "TRS", "TRU", "TSC", "TSS", "TST", "TTA", "TTB", "TTD", "TTL", "TTM", "TTP", "TTR", "TTS", "TTT", "TTU", "TTV", "TUR", "TWO", "UFC", "UND", "UNL", "UPD", "UPK", "URC", "USF", "USV", "USW", "UTL", "UTP", "UUC", "UUM", "UUT", "VAA", "VAB", "VCL", "VCR", "VEX", "VFN", "VIS", "VIT", "VOR", "VSO", "VTS", "VVL", "VVP", "WAR", "WAT", "WBB", "WCT", "WDS", "WEA", "WEI", "WFG", "WFH", "WFT", "WHC", "WRB", "WRC", "WRE", "WRI", "WSA", "WTG", "WTM", "WTV", "WWC", "Z01", "Z02", "Z03", "Z04", "Z05", "Z06", "Z07", "Z08", "Z09", "Z10", "Z11", "Z12", "Z13", "Z14", "Z15", "Z16", "Z17", "Z18", "Z19", "Z20", "Z21", "Z22", "Z23", "Z24", "Z25", "Z26", "Z27", "Z28", "Z29", "Z30", "Z31", "Z32", "Z33", "Z34", "Z35", "ZFF", "ZZZ" ], "nullable": false, "title": "EdiAccessorialCodesEnum" }, "numeric": { "nullable": false, "title": "numeric" }, "InvoiceLineItemsSetInput": { "description": "input type for updating data in table \"invoice_line_items\"", "nullable": false, "properties": { "accessorialCode": { "$ref": "#/components/schemas/EdiAccessorialCodesEnum" }, "description": { "nullable": true, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "remoteId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "InvoiceLineItemsSetInput", "type": "object" }, "CurrencyCodeEnum": { "enum": [ "AED", "AUD", "BRL", "CAD", "CHF", "CNY", "EGP", "EUR", "GBP", "HKD", "IDR", "INR", "JPY", "KRW", "MXN", "MYR", "NZD", "QAR", "SAR", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR" ], "nullable": false, "title": "CurrencyCodeEnum" }, "date": { "nullable": false, "title": "date", "type": "string", "format": "date", "description": "A date string, such as 2024-02-03 (YYYY-MM-DD)" }, "CarrierInvoiceStatusEnum": { "enum": [ "APPROVED", "AWAITING_BILL", "AWAITING_CARRIER_RESPONSE", "AWAITING_INVOICE", "CANCELLED", "CARRIER_EXCEPTION", "CARRIER_RESPONDED", "DISPUTED", "EXCEPTION", "PAID", "PART_PAID", "PROCESSING", "RECEIVED", "REFUNDED", "REJECTED", "UNDER_REVIEW" ], "nullable": false, "title": "CarrierInvoiceStatusEnum" }, "CarrierInvoicesInsertInput": { "description": "input type for inserting data into table \"carrier_invoices\"", "nullable": false, "properties": { "additionalReferenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "approvalRequests": { "type": "object", "description": "CarrierInvoiceApprovalRequestArrRelInsertInput (simplified)" }, "approvedAt": { "$ref": "#/components/schemas/timestamptz" }, "assignedAt": { "$ref": "#/components/schemas/timestamptz" }, "assignedBy": { "type": "object", "description": "UsersObjRelInsertInput (simplified)" }, "assignedById": { "$ref": "#/components/schemas/uuid" }, "assignedTo": { "type": "object", "description": "UsersObjRelInsertInput (simplified)" }, "assignedToId": { "$ref": "#/components/schemas/uuid" }, "balance": { "nullable": true, "title": "Int", "type": "integer", "description": "The balance of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "billId": { "nullable": true, "title": "String", "type": "string" }, "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierBillingAddress": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "carrierBillingAddressId": { "nullable": true, "title": "String", "type": "string" }, "carrierDocumentRequests": { "type": "object", "description": "CarrierDocumentRequestsArrRelInsertInput (simplified)" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierName": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerInvoiceId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "documentsModifiedAt": { "$ref": "#/components/schemas/timestamp" }, "documentsTypeOrCustomerVisibilityUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "dueDate": { "$ref": "#/components/schemas/date" }, "emailMessageAssociations": { "type": "object", "description": "EmailMessageAssociationsArrRelInsertInput (simplified)" }, "factor": { "type": "object", "description": "FactorsObjRelInsertInput (simplified)" }, "factorAddress": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "factorAddressId": { "nullable": true, "title": "String", "type": "string" }, "factorId": { "nullable": true, "title": "String", "type": "string" }, "fileAssociations": { "type": "object", "description": "FileAssociationsArrRelInsertInput (simplified)" }, "id": { "nullable": true, "title": "String", "type": "string" }, "integrationId": { "nullable": true, "title": "String", "type": "string" }, "invoiceErrors": { "type": "object", "description": "InvoiceErrorsArrRelInsertInput (simplified)" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "matchingDisabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mergedFrom": { "type": "object", "description": "CarrierInvoicesArrRelInsertInput (simplified)" }, "mergedIntoCarrierInvoiceId": { "nullable": true, "title": "String", "type": "string" }, "mergedTo": { "type": "object", "description": "CarrierInvoicesObjRelInsertInput (simplified)" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "notes": { "type": "object", "description": "NotesArrRelInsertInput (simplified)" }, "quickPayRequestReasoning": { "nullable": true, "title": "String", "type": "string" }, "quickPayRequestText": { "nullable": true, "title": "String", "type": "string" }, "quickPayRequested": { "nullable": true, "title": "Boolean", "type": "boolean" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "tmsDocumentsUploadStatus": { "$ref": "#/components/schemas/UploadStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer", "description": "The total amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer", "description": "The total tax amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoicesInsertInput", "type": "object" }, "uuid": { "nullable": false, "pattern": "[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89aAbB][a-f0-9]{3}-[a-f0-9]{12}", "title": "uuid", "type": "string" }, "timestamp": { "nullable": false, "title": "timestamp" }, "UploadStatusEnum": { "enum": [ "FAILURE", "INITIATED", "PARTIAL_SUCCESS", "SUCCESS" ], "nullable": false, "title": "UploadStatusEnum" }, "CarrierInvoicesSetInput": { "description": "input type for updating data in table \"carrier_invoices\"", "nullable": false, "properties": { "additionalReferenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "approvedAt": { "$ref": "#/components/schemas/timestamptz" }, "assignedAt": { "$ref": "#/components/schemas/timestamptz" }, "assignedById": { "$ref": "#/components/schemas/uuid" }, "assignedToId": { "$ref": "#/components/schemas/uuid" }, "balance": { "nullable": true, "title": "Int", "type": "integer", "description": "The balance of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "billId": { "nullable": true, "title": "String", "type": "string" }, "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierBillingAddressId": { "nullable": true, "title": "String", "type": "string" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierName": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerInvoiceId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "documentsModifiedAt": { "$ref": "#/components/schemas/timestamp" }, "documentsTypeOrCustomerVisibilityUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "dueDate": { "$ref": "#/components/schemas/date" }, "factorAddressId": { "nullable": true, "title": "String", "type": "string" }, "factorId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "integrationId": { "nullable": true, "title": "String", "type": "string" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "$ref": "#/components/schemas/date" }, "loadNumber": { "nullable": true, "title": "String", "type": "string" }, "matchingDisabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mergedIntoCarrierInvoiceId": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "quickPayRequestReasoning": { "nullable": true, "title": "String", "type": "string" }, "quickPayRequestText": { "nullable": true, "title": "String", "type": "string" }, "quickPayRequested": { "nullable": true, "title": "Boolean", "type": "boolean" }, "receivedAt": { "$ref": "#/components/schemas/timestamptz" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum" }, "tmsDocumentsUploadStatus": { "$ref": "#/components/schemas/UploadStatusEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer", "description": "The total amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "totalTaxAmount": { "nullable": true, "title": "Int", "type": "integer", "description": "The total tax amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoicesSetInput", "type": "object" }, "DateTime": { "description": "The javascript `Date` as string. Type represents date and time as the ISO Date string.", "nullable": false, "title": "DateTime" }, "CreateCarrierInvoiceDocumentInput": { "nullable": false, "properties": { "base64": { "nullable": false, "title": "String", "type": "string" }, "filename": { "nullable": true, "title": "String", "type": "string" }, "mimeType": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": false, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": false, "title": "Boolean", "type": "boolean" } }, "title": "CreateCarrierInvoiceDocumentInput", "type": "object" }, "ExceptionStatusEnum": { "enum": [ "CLOSED", "IN_PROGRESS", "OPEN", "RESOLVED", "RULE_DISABLED" ], "nullable": false, "title": "ExceptionStatusEnum" }, "ExceptionTypeEnum": { "enum": [ "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH", "CARRIER_INVOICE_HAS_LUMPER_LINE_ITEM_AND_NO_LUMPER_RECEIPT", "CARRIER_INVOICE_MISSING", "CARRIER_INVOICE_MISSING_ISSUE_DATE", "CARRIER_INVOICE_MISSING_POD", "CARRIER_INVOICE_MISSING_POD_FOR_EACH_DELIVERY_STOP", "CARRIER_INVOICE_MISSING_RATE_CONFIRMATION", "CARRIER_INVOICE_MISSING_SIGNED_BY", "CARRIER_INVOICE_TOTAL_AMOUNT_BILL_TOTAL_AMOUNT_MISMATCH", "CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH", "CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH_BILL_OR_SHIPMENT", "CARRIER_INVOICE_TOTAL_AMOUNT_SHIPMENT_CARRIER_TOTAL_RATE_MISMATCH", "CARRIER_NAME_MISMATCH", "CARRIER_NAME_MISMATCH_BILL_OR_SHIPMENT", "CARRIER_NAME_MISMATCH_WITH_ASSIGNED_CARRIER", "CARRIER_NAME_MISMATCH_WITH_BILL", "CARRIER_NAME_MISMATCH_WITH_SHIPMENT", "CARRIER_PAY_FROZEN", "CUSTOMER_INVOICE_EXCEPTION", "CUSTOMER_INVOICE_HAS_LUMPER_LINE_ITEM_AND_NO_LUMPER_RECEIPT", "CUSTOMER_INVOICE_MISSING_BOL", "CUSTOMER_INVOICE_MISSING_INVOICE_COPY", "CUSTOMER_INVOICE_MISSING_POD", "CUSTOMER_INVOICE_MISSING_RATE_CONFIRMATION", "CUSTOMER_INVOICE_POST_DELIVERY_HOLD", "DAMAGE_OR_SHORTAGE", "DOCUMENT_LOAD_NUMBER_MISMATCH", "DOCUMENT_NOT_LEGIBLE", "DOCUMENT_SEVERE_MISCLASSIFICATION", "FINAL_CHECK_PACKET_VALIDATION", "INVOICE_AMOUNT_MISMATCH", "MATCHING_INVOICE_NOT_FOUND", "MISSING_CUSTOMER", "MULTIPLE_MATCHING_INVOICES_FOUND", "NO_ASSIGNED_CARRIER", "NO_CARRIER_NAME", "NO_MATCHING_BILL", "NO_MATCHING_SHIPMENT", "OTHER", "OVERPAYMENT", "REMITTANCE_LINE_ITEMS_EXCEPTION", "REMIT_TO_MISMATCH", "SHIPMENT_ON_HOLD", "SHIPPER_INVOICE_DOCUMENT_RULES_EXCEPTION", "TMS_INCIDENT", "TMS_STATUS_MISMATCH", "UNDERPAYMENT", "UNRESOLVED_BILLING_ROUTE" ], "nullable": false, "title": "ExceptionTypeEnum" }, "GenerateUploadUrlInput": { "nullable": false, "properties": { "associationId": { "nullable": true, "title": "String", "type": "string" }, "associationType": { "$ref": "#/components/schemas/AllowedFileAssociationTypeEnum" }, "documentType": { "$ref": "#/components/schemas/AllowedDocumentType" }, "fileName": { "nullable": false, "title": "String", "type": "string" }, "isPod": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mimeType": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": true, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": true, "title": "Boolean", "type": "boolean" } }, "title": "GenerateUploadUrlInput", "type": "object" }, "AllowedFileAssociationTypeEnum": { "description": "The type of the file association", "enum": [ "CARRIER_INVOICE", "INVOICE", "PURCHASE_ORDER", "SHIPMENT", "VENDOR_INVOICE" ], "nullable": false, "title": "AllowedFileAssociationTypeEnum" }, "AllowedDocumentType": { "description": "The type of the document", "enum": [ "ACCESSORIAL_RECEIPT", "ADVANCE_REQUEST", "AGENT_INVOICE", "ARRIVAL_NOTICE", "ASBESTOS_DECLARATION", "AUSFTA", "AUTHORITY", "AUTH_RELEASE", "B3_CANADIAN_ENTRY", "BALANCE_DUE", "BILL_OF_LADING", "CARRIER_ACH_SETUP_FORM", "CARRIER_BOOKING_REQUEST", "CARRIER_INSURANCE_CERTIFICATE", "CARRIER_INVOICE", "CARRIER_INVOICE_SUMMARY", "CARRIER_INVOICE_WITH_SUPPORTING_DOCUMENTATION", "CARRIER_RATE_CONFIRMATION", "CARRIER_W9", "CARTAGE_ADVICE_WITH_RECEIPT", "CERTIFICATE_OF_ORIGIN", "CFDI", "CLAIM", "CLAIM_NOTICE", "COMCHECK", "COMMERCIAL_INVOICE", "CONSIGNMENT_SECURITY_DECLARATION", "CONTRACT", "CORRECTION_NOTICE", "COVER_SHEET", "CREDIT_APPLICATION", "CUSTOMER_DOCUMENTS_OTHER", "CUSTOMER_INVOICE", "CUSTOMER_INVOICE_WITH_SUPPORTING_DOCUMENTATION", "CUSTOMER_RATE_CONFIRMATION", "CUSTOMER_RELEASE", "CUSTOMS_AUTHORITY", "CUSTOMS_CLEARANCE_REQUEST", "CUSTOMS_DOCUMENT", "CUSTOMS_ENTRY_SUMMARY", "CUSTOMS_POWER_OF_ATTORNEY", "DANGEROUS_GOODS_DECLARATION", "DELIVERY_ORDER", "DELIVERY_PHOTO", "DELIVERY_RECEIPT", "DEMURRAGE_RECEIPT", "DETENTION_APPROVAL", "DOCUMENT_BUNDLE", "DOCUMENT_PACKET", "DRIVER_FORM", "ELECTRONIC_INTERCHANGE_RECEIPT", "EMAIL_APPROVAL", "EMAIL_SIGNATURE_IMAGE", "ESCORT_RECEIPT", "EXIT_PASS", "EXPORT_AUTHORITY", "EXPORT_DECLARATION", "FACTOR_INVOICE", "FERRY_RECEIPT", "FINE", "FORM_1113_PUBLIC_VOUCHER", "FREETIME_NOTIFICATION", "FREIGHT_LABEL", "FUEL_RECEIPT", "FUMIGATION_CERTIFICATE", "FUNDING_REQUEST_FORM", "GATE_PASS", "GOVERNMENT_BOL", "HIDDEN_BOL", "HOUSE_AIRWAY_BILL", "HOUSE_BOL", "HOUSE_OCEAN_BOL", "INSPECTION_CERTIFICATE", "INSTRUCTION_PAGE", "INTERMODAL_IN_TRANSIT_NOTICE", "INTERNAL_DOCUMENTS_OTHER", "INTERNAL_PROOF_OF_DELIVERY", "INTERNATIONAL_BOL", "INVOICE_STATEMENT", "ISF_FILING_INSTRUCTION", "LAYOVER_APPROVAL", "LETTER_OF_ASSIGNMENT", "LETTER_OF_CREDIT", "LUMPER_APPROVAL", "LUMPER_RECEIPT", "MANIFEST", "MASTER_AIRWAY_BILL", "MASTER_BOL", "MASTER_OCEAN_BOL", "MOTOR_VEHICLE_CERT", "MSDS", "NAFTA_CERT", "NMFC_W_I_CERT", "NOTICE_OF_ASSIGNMENT", "NOTICE_OF_RELEASE", "OTHER", "PACKING_DECLARATION", "PACKING_SLIP", "PALLET_RECEIPT", "PERMIT_TO_TRANSFER", "PER_DIEM_RECEIPT", "PICKUP_NUMBER", "PRE_ALERT", "PROFORMA_INVOICE", "PROOF_OF_DELIVERY", "PURCHASE_ORDER", "REMITTANCE", "RUN_TICKET", "SANITARY_CERTIFICATE", "SCALE_TICKET", "SHIPPERS_LETTER", "SHIPPER_SECURITY_DECLARATION", "SOLAS_FORM", "SPOT_QUOTE_APPROVAL", "STEAMING_RECEIPT", "SUPPORTING_DOCUMENTATION", "TELEX_RELEASE", "TOLL_RECEIPT", "TONU_APPROVAL", "TRACKING_STATUS", "TRAILER_INTERCHANGE_REPORT", "TRUCK_BOL", "UNKNOWN", "US_CUSTOMS_DOC", "VENDOR_INVOICE", "VETERINARY_CERTIFICATE", "VGM_CONTAINER_INFO", "VOIDED_CHECK", "WASH_RECEIPT", "WAYBILL", "WEIGHT_MEASUREMENT_REPORT", "WEIGHT_TICKET", "WEIGHT_UNLOADED" ], "nullable": false, "title": "AllowedDocumentType" }, "CountryCodeEnum": { "enum": [ "AD", "AE", "AF", "AG", "AL", "AM", "AO", "AR", "AT", "AU", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BN", "BO", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "ER", "ES", "ET", "FI", "FJ", "FM", "FR", "GA", "GB", "GD", "GE", "GH", "GM", "GN", "GQ", "GR", "GT", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IN", "IQ", "IR", "IS", "IT", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MR", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NZ", "OM", "PA", "PE", "PG", "PH", "PK", "PL", "PR", "PS", "PT", "PW", "PY", "QA", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SI", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SY", "SZ", "TD", "TG", "TH", "TJ", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VN", "VU", "WS", "YE", "ZA", "ZM", "ZW" ], "nullable": false, "title": "CountryCodeEnum" }, "AddressTypeEnum": { "enum": [ "ADDRESS_BOOK", "CARRIER", "CARRIER_BILLING", "COMPANY_ADDRESS", "CONTACT", "CUSTOMER_BILLING", "DELIVERY_RECEIPT", "LUMPER_RECEIPT", "SHIPMENT_CONSIGNEE", "SHIPMENT_PICKUP", "STOP", "SUPPORTING_DOC_PARTY" ], "nullable": false, "title": "AddressTypeEnum" }, "AddressesInsertInput": { "description": "input type for inserting data into table \"addresses\"", "nullable": false, "properties": { "canonicalAddress": { "type": "object", "description": "CanonicalAddressesObjRelInsertInput (simplified)" }, "canonicalAddressId": { "nullable": true, "title": "String", "type": "string" }, "city": { "nullable": true, "title": "String", "type": "string" }, "company": { "type": "object", "description": "CompaniesObjRelInsertInput (simplified)" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "contactId": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "locationCode": { "type": "object", "description": "LocationCodesObjRelInsertInput (simplified)" }, "locationCodeId": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "AddressesInsertInput", "type": "object" }, "AddressesSetInput": { "description": "input type for updating data in table \"addresses\"", "nullable": false, "properties": { "canonicalAddressId": { "nullable": true, "title": "String", "type": "string" }, "city": { "nullable": true, "title": "String", "type": "string" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "companyName": { "nullable": true, "title": "String", "type": "string" }, "contactId": { "nullable": true, "title": "String", "type": "string" }, "country": { "$ref": "#/components/schemas/CountryCodeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "locationCodeId": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phoneNumber": { "nullable": true, "title": "String", "type": "string" }, "stateOrProvince": { "nullable": true, "title": "String", "type": "string" }, "streetLine1": { "nullable": true, "title": "String", "type": "string" }, "streetLine2": { "nullable": true, "title": "String", "type": "string" }, "streetLine3": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/AddressTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "zipOrPostalCode": { "nullable": true, "title": "String", "type": "string" } }, "title": "AddressesSetInput", "type": "object" }, "CarriersSetInput": { "description": "input type for updating data in table \"carriers\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "addressesLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "aljexId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "freezePay": { "nullable": true, "title": "Boolean", "type": "boolean" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "isOwnerOperator": { "nullable": true, "title": "Boolean", "type": "boolean" }, "isQuickpay": { "nullable": true, "title": "Boolean", "type": "boolean" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" } }, "title": "CarriersSetInput", "type": "object" }, "CarriersInsertInput": { "description": "input type for inserting data into table \"carriers\"", "nullable": false, "properties": { "address": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "addressesLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "aljexId": { "nullable": true, "title": "String", "type": "string" }, "billingAddressId": { "nullable": true, "title": "String", "type": "string" }, "cargoInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dotNumber": { "nullable": true, "title": "String", "type": "string" }, "email": { "nullable": true, "title": "String", "type": "string" }, "freezePay": { "nullable": true, "title": "Boolean", "type": "boolean" }, "generalLiabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "isOwnerOperator": { "nullable": true, "title": "Boolean", "type": "boolean" }, "isQuickpay": { "nullable": true, "title": "Boolean", "type": "boolean" }, "liabilityInsuranceExpireDate": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "payToAddress": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "phone": { "nullable": true, "title": "String", "type": "string" }, "scacNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" } }, "title": "CarriersInsertInput", "type": "object" }, "BillLineItemsInsertInput": { "description": "input type for inserting data into table \"bill_line_items\"", "nullable": false, "properties": { "billId": { "nullable": false, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "BillLineItemsInsertInput", "type": "object" }, "BillLineItemsSetInput": { "description": "input type for updating data in table \"bill_line_items\"", "nullable": false, "properties": { "description": { "nullable": true, "title": "String", "type": "string" }, "item": { "nullable": true, "title": "String", "type": "string" }, "lineNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPrice": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "BillLineItemsSetInput", "type": "object" }, "AppointmentTypeEnum": { "enum": [ "APT", "FCFS" ], "nullable": false, "title": "AppointmentTypeEnum" }, "float8": { "nullable": false, "title": "float8" }, "StopsInsertInput": { "description": "input type for inserting data into table \"stops\"", "nullable": false, "properties": { "address": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/StopTypeEnum" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "StopsInsertInput", "type": "object" }, "StopTypeEnum": { "enum": [ "CONSOLIDATION", "CROSS_DOCK", "CUSTOMS", "DECONSOLIDATION", "DELIVERY", "DROP_OFF", "FUEL_STOP", "LAYOVER", "ORIGIN", "OTHER", "PICKUP", "RETURN", "STORAGE", "TERMINAL", "TRANSFER" ], "nullable": false, "title": "StopTypeEnum" }, "StopsSetInput": { "description": "input type for updating data in table \"stops\"", "nullable": false, "properties": { "addressId": { "nullable": true, "title": "String", "type": "string" }, "appointmentEnd": { "$ref": "#/components/schemas/timestamptz" }, "appointmentStart": { "$ref": "#/components/schemas/timestamptz" }, "appointmentTimezone": { "nullable": true, "title": "String", "type": "string" }, "appointmentType": { "$ref": "#/components/schemas/AppointmentTypeEnum" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "pieceCount": { "nullable": true, "title": "Int", "type": "integer" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "sequenceNumber": { "nullable": true, "title": "Int", "type": "integer" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "stopType": { "nullable": true, "title": "String", "type": "string" }, "type": { "$ref": "#/components/schemas/StopTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "weightAmount": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "StopsSetInput", "type": "object" }, "SupportingDocsMarkTypeEnum": { "enum": [ "MARK", "SIGNATURE" ], "nullable": false, "title": "SupportingDocsMarkTypeEnum" }, "SupportingDocsAnnotationTypeEnum": { "enum": [ "DIGITAL", "HANDWRITTEN", "STAMP", "TYPED" ], "nullable": false, "title": "SupportingDocsAnnotationTypeEnum" }, "SupportingDocsVendorInvoicesSetInput": { "description": "input type for updating data in table \"supporting_docs.vendor_invoices\"", "nullable": true, "properties": { "accountNumber": { "nullable": true, "title": "String", "type": "string" }, "amountReceived": { "nullable": true, "title": "Int", "type": "integer" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "$ref": "#/components/schemas/date" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightAmount": { "nullable": true, "title": "Int", "type": "integer" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "invoiceDate": { "$ref": "#/components/schemas/date" }, "invoiceNumber": { "nullable": true, "title": "String", "type": "string" }, "legibilityReasoning": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "orderDate": { "$ref": "#/components/schemas/date" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "requisitionerName": { "nullable": true, "title": "String", "type": "string" }, "salesOrderNumber": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "shipmentInfo": { "$ref": "#/components/schemas/jsonb" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "surchargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxExempt": { "nullable": true, "title": "Boolean", "type": "boolean" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" } }, "title": "SupportingDocsVendorInvoicesSetInput", "type": "object" }, "DocumentReferenceSpecificationsInsertInput": { "description": "input type for inserting data into table \"document_reference_specifications\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customer": { "type": "object", "description": "CustomersObjRelInsertInput (simplified)" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecificationsInsertInput", "type": "object" }, "DocumentReferenceSpecificationsSetInput": { "description": "input type for updating data in table \"document_reference_specifications\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamp" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "formatRegex": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "nameRegex": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" } }, "title": "DocumentReferenceSpecificationsSetInput", "type": "object" }, "SupportingDocsVendorInvoiceLineItemsSetInput": { "description": "input type for updating data in table \"supporting_docs.vendor_invoice_line_items\"", "nullable": true, "properties": { "chargeType": { "nullable": true, "title": "String", "type": "string" }, "customerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "discountPercent": { "$ref": "#/components/schemas/numeric" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "poLineNumber": { "nullable": true, "title": "String", "type": "string" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "quantityBackordered": { "$ref": "#/components/schemas/numeric" }, "quantityOrdered": { "$ref": "#/components/schemas/numeric" }, "quantityShipped": { "$ref": "#/components/schemas/numeric" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsVendorInvoiceLineItemsSetInput", "type": "object" }, "PaymentsInsertInput": { "description": "input type for inserting data into table \"payments\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": true, "title": "String", "type": "string" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsArrRelInsertInput (simplified)" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "$ref": "#/components/schemas/PaymentStatusesEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentsInsertInput", "type": "object" }, "PaymentStatusesEnum": { "enum": [ "DISPUTED", "FAILED", "PAYMENT_REVERSED", "PENDING", "REFUNDED", "SUCCEEDED" ], "nullable": false, "title": "PaymentStatusesEnum" }, "PaymentsSetInput": { "description": "input type for updating data in table \"payments\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "id": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "$ref": "#/components/schemas/PaymentStatusesEnum" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentsSetInput", "type": "object" }, "BillsInsertInput": { "description": "input type for inserting data into table \"bills\"", "nullable": false, "properties": { "billLineItems": { "type": "object", "description": "BillLineItemsArrRelInsertInput (simplified)" }, "billLineItemsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dueDate": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "issueDate": { "nullable": true, "title": "String", "type": "string" }, "mcleodSettlementTransferError": { "nullable": true, "title": "String", "type": "string" }, "mcleodSettlementTransferResponse": { "$ref": "#/components/schemas/jsonb" }, "mcleodSettlementTransferredAt": { "$ref": "#/components/schemas/timestamptz" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "payToAccount": { "nullable": true, "title": "String", "type": "string" }, "proNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terms": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "vendor": { "type": "object", "description": "VendorsObjRelInsertInput (simplified)" }, "vendorId": { "nullable": true, "title": "String", "type": "string" } }, "title": "BillsInsertInput", "type": "object" }, "DocumentTypeEnum": { "enum": [ "ACCESSORIAL_RECEIPT", "ADVANCE_REQUEST", "AGENT_INVOICE", "ARRIVAL_NOTICE", "ASBESTOS_DECLARATION", "AUSFTA", "AUTHORITY", "AUTH_RELEASE", "B3_CANADIAN_ENTRY", "BALANCE_DUE", "BILL_OF_LADING", "CARRIER_ACH_SETUP_FORM", "CARRIER_BOOKING_REQUEST", "CARRIER_INSURANCE_CERTIFICATE", "CARRIER_INVOICE", "CARRIER_INVOICE_SUMMARY", "CARRIER_INVOICE_WITH_SUPPORTING_DOCUMENTATION", "CARRIER_RATE_CONFIRMATION", "CARRIER_W9", "CARTAGE_ADVICE_WITH_RECEIPT", "CERTIFICATE_OF_ORIGIN", "CFDI", "CLAIM", "CLAIM_NOTICE", "COMCHECK", "COMMERCIAL_INVOICE", "CONSIGNMENT_SECURITY_DECLARATION", "CONTRACT", "CORRECTION_NOTICE", "COVER_SHEET", "CREDIT_APPLICATION", "CUSTOMER_DOCUMENTS_OTHER", "CUSTOMER_INVOICE", "CUSTOMER_INVOICE_WITH_SUPPORTING_DOCUMENTATION", "CUSTOMER_RATE_CONFIRMATION", "CUSTOMER_RELEASE", "CUSTOMS_AUTHORITY", "CUSTOMS_CLEARANCE_REQUEST", "CUSTOMS_DOCUMENT", "CUSTOMS_ENTRY_SUMMARY", "CUSTOMS_POWER_OF_ATTORNEY", "DANGEROUS_GOODS_DECLARATION", "DELIVERY_ORDER", "DELIVERY_PHOTO", "DELIVERY_RECEIPT", "DEMURRAGE_RECEIPT", "DETENTION_APPROVAL", "DOCUMENT_BUNDLE", "DOCUMENT_PACKET", "DRIVER_FORM", "ELECTRONIC_INTERCHANGE_RECEIPT", "EMAIL_APPROVAL", "EMAIL_SIGNATURE_IMAGE", "ESCORT_RECEIPT", "EXIT_PASS", "EXPORT_AUTHORITY", "EXPORT_DECLARATION", "FACTOR_INVOICE", "FERRY_RECEIPT", "FINE", "FORM_1113_PUBLIC_VOUCHER", "FREETIME_NOTIFICATION", "FREIGHT_LABEL", "FUEL_RECEIPT", "FUMIGATION_CERTIFICATE", "FUNDING_REQUEST_FORM", "GATE_PASS", "GOVERNMENT_BOL", "HIDDEN_BOL", "HOUSE_AIRWAY_BILL", "HOUSE_BOL", "HOUSE_OCEAN_BOL", "INSPECTION_CERTIFICATE", "INSTRUCTION_PAGE", "INTERMODAL_IN_TRANSIT_NOTICE", "INTERNAL_DOCUMENTS_OTHER", "INTERNAL_PROOF_OF_DELIVERY", "INTERNATIONAL_BOL", "INVOICE_STATEMENT", "ISF_FILING_INSTRUCTION", "LAYOVER_APPROVAL", "LETTER_OF_ASSIGNMENT", "LETTER_OF_CREDIT", "LUMPER_APPROVAL", "LUMPER_RECEIPT", "MANIFEST", "MASTER_AIRWAY_BILL", "MASTER_BOL", "MASTER_OCEAN_BOL", "MOTOR_VEHICLE_CERT", "MSDS", "NAFTA_CERT", "NMFC_W_I_CERT", "NOTICE_OF_ASSIGNMENT", "NOTICE_OF_RELEASE", "OTHER", "PACKING_DECLARATION", "PACKING_SLIP", "PALLET_RECEIPT", "PERMIT_TO_TRANSFER", "PER_DIEM_RECEIPT", "PICKUP_NUMBER", "PRE_ALERT", "PROFORMA_INVOICE", "PROOF_OF_DELIVERY", "PURCHASE_ORDER", "REMITTANCE", "RUN_TICKET", "SANITARY_CERTIFICATE", "SCALE_TICKET", "SHIPPERS_LETTER", "SHIPPER_SECURITY_DECLARATION", "SOLAS_FORM", "SPOT_QUOTE_APPROVAL", "STEAMING_RECEIPT", "SUPPORTING_DOCUMENTATION", "TELEX_RELEASE", "TOLL_RECEIPT", "TONU_APPROVAL", "TRACKING_STATUS", "TRAILER_INTERCHANGE_REPORT", "TRUCK_BOL", "UNKNOWN", "US_CUSTOMS_DOC", "VENDOR_INVOICE", "VETERINARY_CERTIFICATE", "VGM_CONTAINER_INFO", "VOIDED_CHECK", "WASH_RECEIPT", "WAYBILL", "WEIGHT_MEASUREMENT_REPORT", "WEIGHT_TICKET", "WEIGHT_UNLOADED" ], "nullable": false, "title": "DocumentTypeEnum" }, "DocumentsSetInput": { "description": "input type for updating data in table \"documents\"", "nullable": true, "properties": { "classifiedTypeString": { "nullable": true, "title": "String", "type": "string" }, "isPodReceivables": { "nullable": true, "title": "Boolean", "type": "boolean" }, "isSevereMismatch": { "nullable": true, "title": "Boolean", "type": "boolean" }, "legibilityReasoning": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "nullable": true, "title": "Int", "type": "integer" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "typeMatches": { "nullable": true, "title": "Boolean", "type": "boolean" } }, "title": "DocumentsSetInput", "type": "object" }, "PaymentLineItemsInsertInput": { "description": "input type for inserting data into table \"payment_line_items\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": true, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItemsInsertInput", "type": "object" }, "RuleActionTypeEnum": { "enum": [ "CREATE_EXCEPTION", "ROUTE_TO_SCAC", "SET_CUSTOMER_BY_CASS_ID", "SET_CUSTOMER_BY_CUSTOMER_NAME", "SET_REQUIRED_DOCUMENTS", "VALIDATE_CONTENT" ], "nullable": false, "title": "RuleActionTypeEnum" }, "RuleCriteriaObjectEnum": { "enum": [ "CUSTOMER", "DOCUMENT", "EMAIL_MESSAGE", "INVOICE", "PARSED_INVOICE", "PORTAL", "SHIPMENT", "TMS" ], "nullable": false, "title": "RuleCriteriaObjectEnum" }, "ComparisonOperatorEnum": { "enum": [ "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY", "ARRAY_HAS_OBJECT_WITH_PROPERTY", "CONTAINED_IN", "CONTAINS", "EQ", "GT", "GTE", "HAS_KEY", "HAS_KEYS_ALL", "HAS_KEYS_ANY", "ILIKE", "IN", "IREGEX", "IS_NULL", "LIKE", "LT", "LTE", "NEQ", "NILIKE", "NIN", "NLIKE", "NREGEX", "NSIMILAR", "REGEX", "SIMILAR" ], "nullable": false, "title": "ComparisonOperatorEnum" }, "RuleTypeEnum": { "enum": [ "CARRIER_INVOICE_EXCEPTION", "CUSTOMER_INVOICE_EXCEPTION", "DOCUMENT_BASIC", "DOCUMENT_CUSTOM", "ON_CREATION_FROM_EMAIL", "REFERENCE_NUMBER", "SCAC_ROUTING" ], "nullable": false, "title": "RuleTypeEnum" }, "RulesInsertInput": { "description": "input type for inserting data into table \"rules\"", "nullable": false, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "enabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "exceptionConfig": { "$ref": "#/components/schemas/jsonb" }, "exceptionType": { "$ref": "#/components/schemas/ExceptionTypeEnum" }, "id": { "nullable": true, "title": "String", "type": "string" }, "priority": { "nullable": true, "title": "Int", "type": "integer" }, "ruleActionType": { "type": "object", "description": "RuleActionTypeObjRelInsertInput (simplified)" }, "ruleType": { "type": "object", "description": "RuleTypeObjRelInsertInput (simplified)" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "RulesInsertInput", "type": "object" }, "RulesSetInput": { "description": "input type for updating data in table \"rules\"", "nullable": false, "properties": { "actionType": { "$ref": "#/components/schemas/RuleActionTypeEnum" }, "actionValue": { "$ref": "#/components/schemas/jsonb" }, "conditionExpression": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "criteriaField": { "nullable": true, "title": "String", "type": "string" }, "criteriaObject": { "$ref": "#/components/schemas/RuleCriteriaObjectEnum" }, "criteriaOperator": { "$ref": "#/components/schemas/ComparisonOperatorEnum" }, "criteriaValue": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "enabled": { "nullable": true, "title": "Boolean", "type": "boolean" }, "exceptionConfig": { "$ref": "#/components/schemas/jsonb" }, "exceptionType": { "$ref": "#/components/schemas/ExceptionTypeEnum" }, "id": { "nullable": true, "title": "String", "type": "string" }, "priority": { "nullable": true, "title": "Int", "type": "integer" }, "type": { "$ref": "#/components/schemas/RuleTypeEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "validationExpression": { "nullable": true, "title": "String", "type": "string" } }, "title": "RulesSetInput", "type": "object" }, "CompaniesInsertInput": { "description": "input type for inserting data into table \"companies\"", "nullable": false, "properties": { "addresses": { "type": "object", "description": "AddressesArrRelInsertInput (simplified)" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "shipments": { "type": "object", "description": "ShipmentsArrRelInsertInput (simplified)" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "CompaniesInsertInput", "type": "object" }, "CompaniesSetInput": { "description": "input type for updating data in table \"companies\"", "nullable": false, "properties": { "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "deletedAt": { "$ref": "#/components/schemas/timestamptz" }, "dunsNumber": { "nullable": true, "title": "String", "type": "string" }, "id": { "nullable": true, "title": "String", "type": "string" }, "logoUrl": { "nullable": true, "title": "String", "type": "string" }, "mcNumber": { "nullable": true, "title": "String", "type": "string" }, "name": { "nullable": true, "title": "String", "type": "string" }, "primaryEmailAddress": { "nullable": true, "title": "String", "type": "string" }, "primaryPhone": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "termsOfService": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "website": { "nullable": true, "title": "String", "type": "string" } }, "title": "CompaniesSetInput", "type": "object" }, "SupportingDocsPurchaseOrdersSetInput": { "description": "input type for updating data in table \"supporting_docs.purchase_orders\"", "nullable": true, "properties": { "buyerContactName": { "nullable": true, "title": "String", "type": "string" }, "buyerEmail": { "nullable": true, "title": "String", "type": "string" }, "buyerName": { "nullable": true, "title": "String", "type": "string" }, "buyerPhone": { "nullable": true, "title": "String", "type": "string" }, "cancelAfterDate": { "$ref": "#/components/schemas/date" }, "confirmToEmail": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerAccountNumber": { "nullable": true, "title": "String", "type": "string" }, "department": { "nullable": true, "title": "String", "type": "string" }, "fobPoint": { "nullable": true, "title": "String", "type": "string" }, "freightTerms": { "nullable": true, "title": "String", "type": "string" }, "incoterms": { "nullable": true, "title": "String", "type": "string" }, "legibilityReasoning": { "nullable": true, "title": "String", "type": "string" }, "legibilityScore": { "$ref": "#/components/schemas/numeric" }, "miscChargeAmount": { "nullable": true, "title": "Int", "type": "integer" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDescription": { "nullable": true, "title": "String", "type": "string" }, "paymentTermsDiscountDays": { "nullable": true, "title": "Int", "type": "integer" }, "paymentTermsDiscountPercent": { "$ref": "#/components/schemas/numeric" }, "paymentTermsNetDays": { "nullable": true, "title": "Int", "type": "integer" }, "pickupDate": { "$ref": "#/components/schemas/date" }, "poDate": { "$ref": "#/components/schemas/date" }, "poNumber": { "nullable": true, "title": "String", "type": "string" }, "poType": { "nullable": true, "title": "String", "type": "string" }, "projectNumber": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseNumber": { "nullable": true, "title": "String", "type": "string" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "requestedShipDate": { "$ref": "#/components/schemas/date" }, "requesterName": { "nullable": true, "title": "String", "type": "string" }, "requisitionNumber": { "nullable": true, "title": "String", "type": "string" }, "revisionDate": { "$ref": "#/components/schemas/date" }, "revisionNumber": { "nullable": true, "title": "String", "type": "string" }, "shipToCode": { "nullable": true, "title": "String", "type": "string" }, "shipVia": { "nullable": true, "title": "String", "type": "string" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "subtotalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalQuantity": { "$ref": "#/components/schemas/numeric" }, "totalVolume": { "$ref": "#/components/schemas/numeric" }, "totalWeight": { "$ref": "#/components/schemas/numeric" }, "vendorInstructions": { "nullable": true, "title": "String", "type": "string" }, "vendorNumber": { "nullable": true, "title": "String", "type": "string" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrdersSetInput", "type": "object" }, "bigint": { "nullable": false, "title": "bigint" }, "InvoiceStatusEnum": { "enum": [ "APPROVED", "CANCELLED", "CREATED", "DELIVERED", "DISPUTED", "DRAFT", "OPEN", "OVERDUE", "PAID", "PART_PAID", "PORTAL_EXCEPTION", "PORTAL_RESOLVED", "PROCESSING", "REFUNDED", "REJECTED", "SEND_ERROR", "SENT", "VIEWED", "WRITE_OFF" ], "nullable": false, "title": "InvoiceStatusEnum" }, "InvoicesInsertInput": { "description": "input type for inserting data into table \"invoices\"", "nullable": false, "properties": { "approvedToSend": { "nullable": true, "title": "Boolean", "type": "boolean" }, "balance": { "$ref": "#/components/schemas/bigint", "description": "The balance of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billToCustomer": { "type": "object", "description": "CustomersObjRelInsertInput (simplified)" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "companyDivision": { "nullable": true, "title": "String", "type": "string" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "debitsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryDate": { "$ref": "#/components/schemas/date" }, "documentExceptions": { "$ref": "#/components/schemas/jsonb" }, "dueDate": { "$ref": "#/components/schemas/date" }, "exceptions": { "type": "object", "description": "ExceptionsArrRelInsertInput (simplified)" }, "externallyManaged": { "nullable": true, "title": "Boolean", "type": "boolean" }, "fileAssociations": { "type": "object", "description": "FileAssociationsArrRelInsertInput (simplified)" }, "fileAssociationsUpdatedAt": { "$ref": "#/components/schemas/timestamp" }, "finalCheckPassedAt": { "$ref": "#/components/schemas/timestamptz" }, "invoiceErrors": { "type": "object", "description": "InvoiceErrorsArrRelInsertInput (simplified)" }, "invoiceLineItems": { "type": "object", "description": "InvoiceLineItemsArrRelInsertInput (simplified)" }, "invoicePriorityActions": { "type": "object", "description": "InvoicePriorityActionsArrRelInsertInput (simplified)" }, "invoiceSnooze": { "type": "object", "description": "InvoiceSnoozesObjRelInsertInput (simplified)" }, "invoiceSnoozes": { "type": "object", "description": "InvoiceSnoozesArrRelInsertInput (simplified)" }, "issueDate": { "$ref": "#/components/schemas/date" }, "lastUpdatedByEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "lineItemsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "listBillDeliveryInvoices": { "type": "object", "description": "ListBillDeliveryInvoicesArrRelInsertInput (simplified)" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "number": { "nullable": true, "title": "String", "type": "string" }, "paidDate": { "$ref": "#/components/schemas/timestamptz" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsArrRelInsertInput (simplified)" }, "portalException": { "nullable": true, "title": "String", "type": "string" }, "portalInvoiceStatuses": { "type": "object", "description": "PortalInvoiceStatusesArrRelInsertInput (simplified)" }, "portalSlug": { "nullable": true, "title": "String", "type": "string" }, "receivedAt": { "$ref": "#/components/schemas/timestamp" }, "receivedFromPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "scacCode": { "nullable": true, "title": "String", "type": "string" }, "scheduledPaymentDate": { "$ref": "#/components/schemas/date" }, "sentAt": { "$ref": "#/components/schemas/timestamp" }, "sentToPortalSlug": { "nullable": true, "title": "String", "type": "string" }, "shipDate": { "$ref": "#/components/schemas/date" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "splitLineage": { "type": "object", "description": "InvoiceSplitLineageObjRelInsertInput (simplified)" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum", "enum": [ "created", "open", "sent", "viewed", "paid", "part-paid", "disputed", "overdue", "cancelled", "write-off", "refunded", "send-error" ] }, "supportingDocPacketBuiltAgainstAt": { "$ref": "#/components/schemas/timestamp" }, "totalAmount": { "$ref": "#/components/schemas/bigint", "description": "The total amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." }, "totalTaxAmount": { "$ref": "#/components/schemas/bigint", "description": "The total tax amount of the invoice. This should be in cents. For example, $100.00 should be represented as 10000." } }, "title": "InvoicesInsertInput", "type": "object" }, "CreateInvoiceDocumentInput": { "nullable": false, "properties": { "base64": { "nullable": false, "title": "String", "type": "string" }, "filename": { "nullable": true, "title": "String", "type": "string" }, "mimeType": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": false, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": false, "title": "Boolean", "type": "boolean" } }, "title": "CreateInvoiceDocumentInput", "type": "object" }, "CustomersInsertInput": { "description": "input type for inserting data into table \"customers\"", "nullable": false, "properties": { "addresses": { "type": "object", "description": "AddressesArrRelInsertInput (simplified)" }, "addressesLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "billToCode": { "nullable": true, "title": "String", "type": "string" }, "billToCustomerId": { "nullable": true, "title": "String", "type": "string" }, "billToSource": { "nullable": true, "title": "String", "type": "string" }, "ccEmailAddresses": { "items": { "nullable": false, "title": "String", "type": "string" }, "nullable": true, "type": "array" }, "childCustomers": { "type": "object", "description": "CustomersArrRelInsertInput (simplified)" }, "collectorId": { "$ref": "#/components/schemas/uuid" }, "contacts": { "type": "object", "description": "ContactsArrRelInsertInput (simplified)" }, "contactsLastUpdatedAt": { "$ref": "#/components/schemas/timestamptz" }, "customerEmailSettings": { "type": "object", "description": "CustomerEmailSettingsArrRelInsertInput (simplified)" }, "customerIntegrationSettings": { "type": "object", "description": "CustomerIntegrationSettingsArrRelInsertInput (simplified)" }, "customerRule": { "type": "object", "description": "CustomerRulesObjRelInsertInput (simplified)" }, "deletedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryRoutingRules": { "type": "object", "description": "DeliveryRoutingRulesArrRelInsertInput (simplified)" }, "emailAddress": { "nullable": true, "title": "String", "type": "string" }, "invoiceSplitRules": { "type": "object", "description": "InvoiceSplitRulesArrRelInsertInput (simplified)" }, "isActive": { "nullable": true, "title": "Boolean", "type": "boolean" }, "mergedIntoCustomer": { "type": "object", "description": "CustomersObjRelInsertInput (simplified)" }, "mergedIntoCustomerId": { "nullable": true, "title": "String", "type": "string" }, "metadata": { "$ref": "#/components/schemas/jsonb" }, "name": { "nullable": true, "title": "String", "type": "string" }, "paymentDiscountTerms": { "$ref": "#/components/schemas/jsonb" }, "paymentLineItems": { "type": "object", "description": "PaymentLineItemsArrRelInsertInput (simplified)" }, "remittanceLineItems": { "type": "object", "description": "RemittanceLineItemsArrRelInsertInput (simplified)" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "statementSchedules": { "type": "object", "description": "StatementSchedulesArrRelInsertInput (simplified)" }, "tmsBalanceCents": { "$ref": "#/components/schemas/bigint" }, "tmsCustomerType": { "nullable": true, "title": "String", "type": "string" } }, "title": "CustomersInsertInput", "type": "object" }, "CarrierInvoiceApprovalRequestStatusEnum": { "enum": [ "ABANDONED", "FAILED", "INITIATED", "IN_PROGRESS", "RETRYING", "SUCCEEDED" ], "nullable": false, "title": "CarrierInvoiceApprovalRequestStatusEnum" }, "CarrierInvoiceApprovalRequestSetInput": { "description": "input type for updating data in table \"carrier_invoice_approval_request\"", "nullable": false, "properties": { "carrierInvoiceId": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "integrationId": { "nullable": true, "title": "String", "type": "string" }, "requestPayload": { "$ref": "#/components/schemas/jsonb" }, "requestedByUserId": { "$ref": "#/components/schemas/uuid" }, "responsePayload": { "$ref": "#/components/schemas/jsonb" }, "retryCount": { "nullable": true, "title": "Int", "type": "integer" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceApprovalRequestStatusEnum" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "CarrierInvoiceApprovalRequestSetInput", "type": "object" }, "PaymentLineItemsSetInput": { "description": "input type for updating data in table \"payment_line_items\"", "nullable": false, "properties": { "checkDate": { "$ref": "#/components/schemas/date" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "exchangeRate": { "nullable": true, "title": "String", "type": "string" }, "fees": { "nullable": true, "title": "Int", "type": "integer" }, "id": { "nullable": true, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "paymentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "totalAmount": { "nullable": true, "title": "Int", "type": "integer" }, "totalAmountWithFees": { "nullable": true, "title": "Int", "type": "integer" }, "transactionDate": { "$ref": "#/components/schemas/date" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "PaymentLineItemsSetInput", "type": "object" }, "ShipmentLineItemsInsertInput": { "description": "input type for inserting data into table \"shipment_line_items\"", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deletedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": true, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItemsInsertInput", "type": "object" }, "EdiHandlingUnitTypeEnum": { "enum": [ "BAG", "BLK", "BOB", "BOT", "BOX", "BRG", "BSK", "BXI", "BXT", "CAB", "CAG", "CAN", "CAR", "CAS", "CBC", "CBY", "CCS", "CHE", "CHS", "CLD", "CNA", "CNB", "CNC", "CND", "CNE", "CNF", "CNT", "CNX", "COL", "CON", "COR", "CRD", "CRT", "CSK", "CTN", "CUB", "CYL", "DBK", "DRK", "DRM", "DSK", "DTB", "DUF", "ENV", "FIR", "FLO", "FLX", "FRM", "FSK", "FWR", "GOH", "HED", "HGH", "HPR", "HPT", "HRB", "HRK", "HTB", "JAR", "JUG", "KEG", "KIT", "KRK", "KTB", "LBK", "LIF", "LOG", "LSE", "LUG", "LVN", "MLV", "MRP", "MSV", "MXD", "NOL", "OVW", "PAL", "PCK", "PCS", "PIR", "PKG", "PLF", "PLL", "PLN", "PLT", "POV", "PRK", "QTR", "RAL", "RCK", "REL", "ROL", "RVR", "SAK", "SBC", "SCS", "SHK", "SHT", "SID", "SKD", "SKE", "SLP", "SLV", "SPI", "SPL", "SVN", "TBE", "TBN", "TKR", "TKT", "TLD", "TNK", "TRC", "TRI", "TRK", "TRU", "TRY", "TSS", "TTC", "UNT" ], "nullable": false, "title": "EdiHandlingUnitTypeEnum" }, "EdiWeightUnitTypeEnum": { "enum": [ "CG", "CT", "CWT", "DAG", "DG", "DTN", "DWT", "G", "GR", "HG", "KG", "KT", "LB", "LT", "MG", "MT", "ONZ", "OZ", "Q", "ST", "T", "UG" ], "nullable": false, "title": "EdiWeightUnitTypeEnum" }, "ShipmentLineItemsSetInput": { "description": "input type for updating data in table \"shipment_line_items\"", "nullable": false, "properties": { "commodityDescription": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamp" }, "deletedAt": { "$ref": "#/components/schemas/timestamp" }, "deliveryLocationName": { "nullable": true, "title": "String", "type": "string" }, "dimensionUnit": { "nullable": true, "title": "String", "type": "string" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "handlingUnit": { "nullable": true, "title": "String", "type": "string" }, "handlingUnitQty": { "$ref": "#/components/schemas/numeric" }, "handlingUnitType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "hazmatFlag": { "nullable": true, "title": "Boolean", "type": "boolean" }, "height": { "$ref": "#/components/schemas/numeric" }, "id": { "nullable": true, "title": "String", "type": "string" }, "length": { "$ref": "#/components/schemas/numeric" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "nmfcClass": { "nullable": true, "title": "String", "type": "string" }, "nmfcNumber": { "nullable": true, "title": "String", "type": "string" }, "packageQty": { "$ref": "#/components/schemas/numeric" }, "packageType": { "$ref": "#/components/schemas/EdiHandlingUnitTypeEnum" }, "packageUnit": { "nullable": true, "title": "String", "type": "string" }, "pickupLocationName": { "nullable": true, "title": "String", "type": "string" }, "referenceNumber": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamp" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" }, "weightUnitType": { "$ref": "#/components/schemas/EdiWeightUnitTypeEnum" }, "width": { "$ref": "#/components/schemas/numeric" } }, "title": "ShipmentLineItemsSetInput", "type": "object" }, "ShipmentsSetInput": { "description": "input type for updating data in table \"shipments\"", "nullable": false, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "billedMiles": { "$ref": "#/components/schemas/numeric" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "freightChargeTerm": { "$ref": "#/components/schemas/FreightChargeTermEnum" }, "holdReason": { "nullable": true, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "movementType": { "nullable": true, "title": "String", "type": "string" }, "onHold": { "nullable": true, "title": "Boolean", "type": "boolean" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "signedBy": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "status": { "nullable": true, "title": "String", "type": "string" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "ShipmentsSetInput", "type": "object" }, "FreightChargeTermEnum": { "enum": [ "AC", "AP", "BP", "CA", "CB", "CC", "CF", "DE", "DF", "FO", "HP", "MX", "NC", "NR", "OC", "OP", "PA", "PB", "PC", "PE", "PO", "PP", "PS", "PU", "RF", "RS", "SC", "SP", "TP", "UC", "WC" ], "nullable": false, "title": "FreightChargeTermEnum" }, "ShipmentsInsertInput": { "description": "input type for inserting data into table \"shipments\"", "nullable": false, "properties": { "billOfLadingNumber": { "nullable": true, "title": "String", "type": "string" }, "billedDate": { "$ref": "#/components/schemas/date" }, "billedMiles": { "$ref": "#/components/schemas/numeric" }, "carrierDocumentRequests": { "type": "object", "description": "CarrierDocumentRequestsArrRelInsertInput (simplified)" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "carrierInvoices": { "type": "object", "description": "CarrierInvoicesArrRelInsertInput (simplified)" }, "carrierProNumber": { "nullable": true, "title": "String", "type": "string" }, "carrierTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "company": { "type": "object", "description": "CompaniesObjRelInsertInput (simplified)" }, "companyId": { "nullable": true, "title": "String", "type": "string" }, "consigneeAddress": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "consigneeAddressId": { "nullable": true, "title": "String", "type": "string" }, "coveredDate": { "$ref": "#/components/schemas/date" }, "createdFromEmailMessageId": { "nullable": true, "title": "String", "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCodeEnum" }, "currencyCode": { "type": "object", "description": "CurrencyCodeObjRelInsertInput (simplified)" }, "customerId": { "nullable": true, "title": "String", "type": "string" }, "customerMiles": { "$ref": "#/components/schemas/numeric" }, "customerPoNumber": { "nullable": true, "title": "String", "type": "string" }, "customerReferenceNumber": { "nullable": true, "title": "String", "type": "string" }, "customerTotalRate": { "nullable": true, "title": "Int", "type": "integer" }, "declaredValue": { "nullable": true, "title": "Int", "type": "integer" }, "deliveredAt": { "$ref": "#/components/schemas/timestamp" }, "dispatchedDate": { "$ref": "#/components/schemas/date" }, "dispatcherEmail": { "nullable": true, "title": "String", "type": "string" }, "dispatcherName": { "nullable": true, "title": "String", "type": "string" }, "dispatcherPhone": { "nullable": true, "title": "String", "type": "string" }, "equipment": { "nullable": true, "title": "String", "type": "string" }, "fileAssociations": { "type": "object", "description": "FileAssociationsArrRelInsertInput (simplified)" }, "freightChargeTerm": { "$ref": "#/components/schemas/FreightChargeTermEnum" }, "freightChargeTermInfo": { "type": "object", "description": "FreightChargeTermObjRelInsertInput (simplified)" }, "freightClass": { "nullable": true, "title": "String", "type": "string" }, "holdReason": { "nullable": true, "title": "String", "type": "string" }, "invoiceId": { "nullable": true, "title": "String", "type": "string" }, "lengthInFeet": { "nullable": true, "title": "Int", "type": "integer" }, "loadDescription": { "nullable": true, "title": "String", "type": "string" }, "loadedDate": { "$ref": "#/components/schemas/date" }, "mode": { "nullable": true, "title": "String", "type": "string" }, "movementType": { "nullable": true, "title": "String", "type": "string" }, "notes": { "type": "object", "description": "NotesArrRelInsertInput (simplified)" }, "onHold": { "nullable": true, "title": "Boolean", "type": "boolean" }, "pickupAddress": { "type": "object", "description": "AddressesObjRelInsertInput (simplified)" }, "pickupAt": { "$ref": "#/components/schemas/timestamp" }, "readyDate": { "$ref": "#/components/schemas/date" }, "referenceNumbers": { "$ref": "#/components/schemas/jsonb" }, "releaseDate": { "$ref": "#/components/schemas/date" }, "serviceLevel": { "nullable": true, "title": "String", "type": "string" }, "shipmentId": { "nullable": true, "title": "String", "type": "string" }, "shipmentLineItems": { "type": "object", "description": "ShipmentLineItemsArrRelInsertInput (simplified)" }, "signedBy": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemMeta": { "$ref": "#/components/schemas/jsonb" }, "specialInstructions": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "stops": { "type": "object", "description": "StopsArrRelInsertInput (simplified)" }, "terminal": { "nullable": true, "title": "String", "type": "string" }, "trailerNumber": { "nullable": true, "title": "String", "type": "string" }, "truckMiles": { "$ref": "#/components/schemas/numeric" }, "volume": { "$ref": "#/components/schemas/float8" }, "volumeUnit": { "nullable": true, "title": "String", "type": "string" }, "weight": { "$ref": "#/components/schemas/float8" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "ShipmentsInsertInput", "type": "object" }, "CreateShipmentDocumentInput": { "nullable": false, "properties": { "base64": { "nullable": false, "title": "String", "type": "string" }, "filename": { "nullable": true, "title": "String", "type": "string" }, "mimeType": { "nullable": false, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "type": { "nullable": false, "title": "String", "type": "string" }, "visibleToCarrier": { "nullable": true, "title": "Boolean", "type": "boolean" }, "visibleToCustomer": { "nullable": true, "title": "Boolean", "type": "boolean" } }, "title": "CreateShipmentDocumentInput", "type": "object" }, "BillPaymentsInsertInput": { "description": "input type for inserting data into table \"bill_payments\"", "nullable": false, "properties": { "amount": { "nullable": true, "title": "Int", "type": "integer" }, "billPaymentLineItems": { "type": "object", "description": "BillPaymentLineItemsArrRelInsertInput (simplified)" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentsInsertInput", "type": "object" }, "BillPaymentsSetInput": { "description": "input type for updating data in table \"bill_payments\"", "nullable": false, "properties": { "amount": { "nullable": true, "title": "Int", "type": "integer" }, "carrierId": { "nullable": true, "title": "String", "type": "string" }, "checkOrAchNumber": { "nullable": true, "title": "String", "type": "string" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "id": { "nullable": true, "title": "String", "type": "string" }, "sourceSystem": { "nullable": true, "title": "String", "type": "string" }, "sourceSystemId": { "nullable": true, "title": "String", "type": "string" }, "status": { "nullable": true, "title": "String", "type": "string" }, "transactionDate": { "nullable": true, "title": "String", "type": "string" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "title": "BillPaymentsSetInput", "type": "object" }, "SupportingDocsPurchaseOrderLineItemsSetInput": { "description": "input type for updating data in table \"supporting_docs.purchase_order_line_items\"", "nullable": true, "properties": { "brand": { "nullable": true, "title": "String", "type": "string" }, "buyerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "contractLineNumber": { "nullable": true, "title": "String", "type": "string" }, "contractNumber": { "nullable": true, "title": "String", "type": "string" }, "deliverTo": { "nullable": true, "title": "String", "type": "string" }, "description": { "nullable": true, "title": "String", "type": "string" }, "extendedAmount": { "nullable": true, "title": "Int", "type": "integer" }, "lineNumber": { "nullable": true, "title": "Int", "type": "integer" }, "lineStatus": { "nullable": true, "title": "String", "type": "string" }, "manufacturerName": { "nullable": true, "title": "String", "type": "string" }, "manufacturerPartNumber": { "nullable": true, "title": "String", "type": "string" }, "notes": { "nullable": true, "title": "String", "type": "string" }, "packSize": { "nullable": true, "title": "String", "type": "string" }, "priceComponents": { "$ref": "#/components/schemas/jsonb" }, "promisedDeliveryDate": { "$ref": "#/components/schemas/date" }, "quantity": { "$ref": "#/components/schemas/numeric" }, "requestedDeliveryDate": { "$ref": "#/components/schemas/date" }, "revision": { "nullable": true, "title": "String", "type": "string" }, "schedules": { "$ref": "#/components/schemas/jsonb" }, "taxAmount": { "nullable": true, "title": "Int", "type": "integer" }, "taxable": { "nullable": true, "title": "Boolean", "type": "boolean" }, "unitOfMeasure": { "nullable": true, "title": "String", "type": "string" }, "unitPriceAmount": { "nullable": true, "title": "Int", "type": "integer" }, "unitPriceBasis": { "$ref": "#/components/schemas/numeric" }, "upc": { "nullable": true, "title": "String", "type": "string" }, "vendorPartNumber": { "nullable": true, "title": "String", "type": "string" }, "volume": { "$ref": "#/components/schemas/numeric" }, "weight": { "$ref": "#/components/schemas/numeric" }, "weightUnit": { "nullable": true, "title": "String", "type": "string" } }, "title": "SupportingDocsPurchaseOrderLineItemsSetInput", "type": "object" }, "CarrierInvoiceWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the event." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was last updated." }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event is scheduled to be processed." }, "processedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event was processed." }, "status": { "type": "string", "description": "The status of the event (e.g., PENDING)." }, "operation": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ], "description": "The operation type that triggered the event." }, "payload": { "type": "object", "properties": { "new": { "$ref": "#/components/schemas/CarrierInvoiceWebhookEventPayload", "description": "The new values of the resource after the operation (for INSERT and UPDATE events)." }, "old": { "$ref": "#/components/schemas/CarrierInvoiceWebhookEventPayload", "description": "The previous values of the resource before the operation (for UPDATE and DELETE events)." } } } }, "required": [ "id", "createdAt", "updatedAt", "status", "operation", "payload" ], "nullable": false }, "CarrierInvoiceWebhookEventPayload": { "type": "object", "properties": { "id": { "type": "string", "description": "Primary key, unique identifier" }, "created_at": { "$ref": "#/components/schemas/timestamptz" }, "updated_at": { "$ref": "#/components/schemas/timestamptz" }, "tenant_id": { "type": "string", "description": "Identifier for the tenant" }, "carrier_id": { "type": [ "string", "null" ], "description": "Identifier for the carrier" }, "invoice_number": { "type": [ "string", "null" ], "description": "Invoice number" }, "issue_date": { "$ref": "#/components/schemas/NullableTimestamptz" }, "due_date": { "$ref": "#/components/schemas/NullableTimestamptz" }, "total_amount": { "$ref": "#/components/schemas/CurrencyAmount" }, "total_tax_amount": { "$ref": "#/components/schemas/CurrencyAmount" }, "balance": { "$ref": "#/components/schemas/CurrencyAmount" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "status": { "$ref": "#/components/schemas/CarrierInvoiceStatusEnum", "description": "Current status of the invoice" }, "source_system_meta": { "type": [ "object", "null" ], "description": "Additional metadata from the source system" }, "reference_numbers": { "type": [ "object", "null" ], "description": "Reference numbers associated with the invoice" }, "metadata": { "type": [ "object", "null" ], "description": "Additional metadata" }, "received_at": { "$ref": "#/components/schemas/timestamptz" }, "shipment_id": { "type": [ "string", "null" ], "description": "Associated shipment identifier" }, "bill_id": { "type": [ "string", "null" ], "description": "Associated bill identifier" }, "load_number": { "type": [ "string", "null" ], "description": "Load number reference" }, "customer_invoice_id": { "type": [ "string", "null" ], "description": "Associated customer invoice identifier" }, "documents_type_or_customer_visibility_updated_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "Timestamp when document types or customer visibility was last updated" }, "created_from_email_message_id": { "type": [ "string", "null" ], "description": "Email message ID if created from email" }, "deleted_at": { "$ref": "#/components/schemas/NullableTimestamptz" }, "documents_modified_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "Timestamp when documents were last modified" } }, "nullable": false }, "NullableTimestamptz": { "oneOf": [ { "$ref": "#/components/schemas/timestamptz" }, { "type": "null" } ], "description": "Timestamp with timezone in ISO 8601 format, or null", "nullable": false }, "CurrencyAmount": { "type": "integer", "description": "Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.", "nullable": false }, "CurrencyCode": { "type": "string", "description": "Three-letter ISO currency code, e.g., USD, CAD, EUR, GBP", "nullable": false }, "FieldSpecificUpdateEventRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the event." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was last updated." }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event is scheduled to be processed." }, "processedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event was processed." }, "status": { "type": "string", "description": "The status of the event (e.g., PENDING)." }, "operation": { "type": "string", "description": "The operation type that triggered the event. Format for specific field updates is `UPDATE..`, where `` is the updated field, and `` is the new value, e.g., `UPDATE.status.SENT` or `UPDATE.carrier_invoice.APPROVED`." }, "payload": { "type": "object", "properties": { "new": { "$ref": "#/components/schemas/InvoiceWebhookEventPayload", "description": "The new values of the resource after the operation. Contains all fields of the resource." }, "old": { "$ref": "#/components/schemas/InvoiceWebhookEventPayload", "description": "The previous values of the resource before the operation. Contains all fields of the resource." } }, "description": "Data regarding the state of the resource involved in the event." }, "table": { "type": "string", "description": "The type of resource in the Upwell application where the event occurred." }, "resourceId": { "type": "string", "description": "The unique identifier for the resource affected by the event." }, "webhookSubscriptionId": { "type": "string", "description": "The unique identifier for the webhook subscription." }, "retryOfId": { "type": [ "string", "null" ], "description": "The ID of the event being retried, if applicable." }, "retries": { "type": "array", "items": { "type": "object" }, "description": "An array of retry attempts for the event." } }, "description": "A payload structure for webhook events triggered by specific field updates in Upwell resources, detailing the affected resource, tenant, operation type, and resource state.", "nullable": false }, "InvoiceWebhookEventPayload": { "type": "object", "properties": { "balance": { "$ref": "#/components/schemas/CurrencyAmount" }, "company_division": { "type": [ "string", "null" ], "description": "The division within the company this invoice belongs to" }, "created_at": { "$ref": "#/components/schemas/timestamptz", "description": "The timestamp when the invoice was created" }, "created_from_email_message_id": { "type": [ "string", "null" ], "description": "ID of the email message that created this invoice" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "customer_id": { "type": "string", "description": "The unique identifier of the customer" }, "debits_updated_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The timestamp when the invoice debits were last updated" }, "delivery_date": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The date when the invoice was delivered" }, "delivery_methods": { "type": "array", "items": { "type": "string" }, "description": "Methods used to deliver the invoice" }, "document_exceptions": { "type": [ "array", "null" ], "items": { "type": "object", "additionalProperties": true }, "description": "List of exceptions related to invoice documents" }, "due_date": { "$ref": "#/components/schemas/NullableDate", "description": "The date when the invoice payment is due" }, "file_associations_updated_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The timestamp when file associations were last updated" }, "hold_for_review": { "type": "boolean", "description": "Whether the invoice is held for review" }, "invoice_creation_event_id": { "type": [ "string", "null" ], "description": "ID of the event that created this invoice" }, "issue_date": { "$ref": "#/components/schemas/NullableDate", "description": "The date when the invoice was issued" }, "line_items_last_updated_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The timestamp when line items were last updated" }, "metadata": { "type": "object", "additionalProperties": true, "description": "Additional metadata associated with the invoice" }, "number": { "type": "string", "description": "The invoice number" }, "portal_exception": { "type": [ "object", "null" ], "additionalProperties": true, "description": "Exception details from the portal processing" }, "portal_slug": { "type": [ "string", "null" ], "description": "The portal identifier associated with this invoice" }, "received_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The timestamp when the invoice was received" }, "received_from_portal_slug": { "type": [ "string", "null" ], "description": "The portal slug from which the invoice was received" }, "reference_numbers": { "type": "array", "items": { "type": "string" }, "description": "Reference numbers associated with the invoice" }, "scheduled_payment_date": { "$ref": "#/components/schemas/NullableDate", "description": "The date when payment is scheduled" }, "sent_at": { "$ref": "#/components/schemas/NullableTimestamptz", "description": "The timestamp when the invoice was sent" }, "sent_to_portal_slug": { "type": [ "string", "null" ], "description": "The portal slug to which the invoice was sent" }, "ship_date": { "$ref": "#/components/schemas/NullableDate", "description": "The date when the goods were shipped" }, "source_system": { "type": "string", "description": "The system where the invoice originated" }, "source_system_id": { "type": "string", "description": "The ID of the invoice in the source system" }, "source_system_meta": { "type": "object", "additionalProperties": true, "description": "Additional metadata from the source system" }, "statement_id": { "type": [ "string", "null" ], "description": "The ID of the statement this invoice belongs to" }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "tenant_id": { "type": "string", "description": "The ID of the tenant this invoice belongs to" }, "total_amount": { "$ref": "#/components/schemas/CurrencyAmount" }, "total_tax_amount": { "$ref": "#/components/schemas/CurrencyAmount" }, "updated_at": { "$ref": "#/components/schemas/timestamptz", "description": "The timestamp when the invoice was last updated" } }, "description": "The payload data structure for invoice-related webhook events", "nullable": false }, "NullableDate": { "oneOf": [ { "$ref": "#/components/schemas/date" }, { "type": "null" } ], "description": "Date in YYYY-MM-DD format, or null", "nullable": false }, "CrudEventRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the event." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was last updated." }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event is scheduled to be processed." }, "processedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event was processed." }, "status": { "type": "string", "description": "The status of the event (e.g., PENDING)." }, "operation": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ], "description": "The operation type that triggered the event." }, "payload": { "type": "object", "properties": { "new": { "type": "object", "description": "The new values of the resource after the operation (for INSERT and UPDATE events). Contains all fields of the resource." }, "old": { "type": "object", "description": "The previous values of the resource before the operation (for UPDATE and DELETE events). Contains all fields of the resource." } }, "description": "Data regarding the state of the resource involved in the event." }, "table": { "type": "string", "description": "The type of resource in the Upwell application where the event occurred." }, "resourceId": { "type": "string", "description": "The unique identifier for the resource affected by the event." }, "webhookSubscriptionId": { "type": "string", "description": "The unique identifier for the webhook subscription." } }, "description": "A payload structure for webhook events triggered by operations in Upwell, detailing the affected resource, tenant, operation type, and resource state.", "nullable": false }, "InvoiceWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the event." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was last updated." }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event is scheduled to be processed." }, "processedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event was processed." }, "status": { "type": "string", "description": "The status of the event (e.g., PENDING)." }, "operation": { "type": "string", "enum": [ "INSERT", "UPDATE", "DELETE" ], "description": "The operation type that triggered the event." }, "payload": { "type": "object", "properties": { "new": { "$ref": "#/components/schemas/InvoiceWebhookEventPayload", "description": "The new values of the resource after the operation (for INSERT and UPDATE events)." }, "old": { "$ref": "#/components/schemas/InvoiceWebhookEventPayload", "description": "The previous values of the resource before the operation (for UPDATE and DELETE events)." } }, "description": "Data regarding the state of the resource involved in the event." }, "table": { "type": "string", "description": "The type of resource in the Upwell application where the event occurred." }, "resourceId": { "type": "string", "description": "The unique identifier for the resource affected by the event." }, "webhookSubscriptionId": { "type": "string", "description": "The unique identifier for the webhook subscription." }, "retryOfId": { "type": [ "string", "null" ], "description": "The ID of the event being retried, if applicable." }, "retries": { "type": "array", "items": { "type": "object" }, "description": "An array of retry attempts for the event." } }, "description": "A payload structure for webhook events triggered by operations in Upwell, detailing the affected resource, tenant, operation type, and resource state.", "nullable": false }, "RemittanceWebhookEvent": { "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier for the event." }, "createdAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was created." }, "updatedAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event was last updated." }, "scheduledAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event is scheduled to be processed." }, "processedAt": { "type": [ "string", "null" ], "format": "date-time", "description": "The timestamp when the event was processed." }, "status": { "type": "string", "description": "The status of the event (e.g., pending, succeeded, sync_error)." }, "operation": { "type": "string", "description": "The operation that triggered the event (e.g., INSERT, UPDATE, DELETE)." }, "trigger": { "type": "string", "description": "The trigger that caused the event (e.g., update.remittance.status.sync_error)." }, "payload": { "type": "object", "description": "The payload of the event, containing the remittance data.", "properties": { "remittance": { "$ref": "#/components/schemas/Remittance" } } }, "table": { "type": "string", "description": "The name of the table associated with the event (e.g., remittances)." }, "webhookSubscriptionId": { "type": "string", "description": "The ID of the webhook subscription that triggered this event." }, "resourceId": { "type": "string", "description": "The ID of the resource affected by the event." }, "retryOfId": { "type": [ "string", "null" ], "description": "The ID of the event this is a retry of, if applicable." }, "retries": { "type": "array", "items": { "type": "object" }, "description": "Array of retry attempts for this event." } }, "required": [ "id", "createdAt", "updatedAt", "status", "operation", "trigger", "payload", "table", "webhookSubscriptionId", "resourceId", "retries" ], "nullable": false }, "Remittance": { "type": [ "object", "null" ], "description": "The state of the remittance record.", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "metadata": { "type": "object" }, "filePath": { "type": [ "string", "null" ] }, "syncedAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" }, "customerId": { "type": "string" }, "batchNumber": { "type": [ "string", "null" ] }, "paymentDate": { "type": "string" }, "paymentMethod": { "type": "string" }, "paymentNumber": { "type": "string" }, "sourceCompany": { "type": "string" }, "totalAmountPaid": { "type": "number" }, "checkOrAchNumber": { "type": [ "string", "null" ] }, "totalAmountBilled": { "type": "number" }, "totalDiscountAmount": { "type": [ "string", "null" ] }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/RemittanceLineItem" } } }, "nullable": false }, "RemittanceLineItem": { "type": "object", "properties": { "id": { "type": "string" }, "comments": { "type": [ "string", "null" ] }, "createdAt": { "$ref": "#/components/schemas/timestamptz" }, "currency": { "$ref": "#/components/schemas/CurrencyCode" }, "customerDocumentNumber": { "type": "string" }, "discountAmount": { "type": [ "string", "null" ] }, "grossAmountBilled": { "type": [ "string", "null" ] }, "invoiceDate": { "type": "string" }, "invoiceNumber": { "type": "string" }, "metadata": { "type": [ "object", "null" ] }, "netAmountPaid": { "type": "number" }, "remittanceId": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "updatedAt": { "$ref": "#/components/schemas/timestamptz" } }, "nullable": false } }, "examples": { "CustomerPaymentsCrudEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T18:31:47.656611", "updatedAt": "2024-11-17T18:31:47.656611", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "id": "pym_example", "fees": "0", "notes": "sample note", "status": "completed", "currency": "USD", "tenant_id": "ten_example", "check_date": null, "created_at": "2024-11-16T00:59:33.492433+00:00", "invoice_id": null, "updated_at": "2024-11-17T18:31:43.868708+00:00", "customer_id": "cus_example", "total_amount": "12500", "exchange_rate": null, "source_system": null, "source_system_id": null, "transaction_date": "2023-01-04", "source_system_meta": { "mergeId": "3358e764-0b63-4c68-8166-4c6e5ee44b5a", "remoteId": "72", "fieldMappings": { "organizationDefinedTargets": null, "linkedAccountDefinedTargets": null }, "mergeCustomerId": "1d53a67e-95ac-4409-be74-af9ddc7c83ce", "remoteUpdatedAt": "2023-01-26T20:50:23Z", "remoteWasDeleted": false, "trackingCategories": [] }, "check_or_ach_number": null, "total_amount_with_fees": null }, "old": { "id": "pym_example", "fees": "0", "notes": null, "status": "completed", "currency": null, "tenant_id": "ten_example", "check_date": null, "created_at": "2024-11-16T00:59:33.492433+00:00", "invoice_id": null, "updated_at": "2024-11-17T18:30:37.07542+00:00", "customer_id": "cus_example", "total_amount": "11500", "exchange_rate": null, "source_system": null, "source_system_id": null, "transaction_date": "2023-01-04", "source_system_meta": { "mergeId": "3358e764-0b63-4c68-8166-4c6e5ee44b5a", "remoteId": "72", "fieldMappings": { "organizationDefinedTargets": null, "linkedAccountDefinedTargets": null }, "mergeCustomerId": "1d53a67e-95ac-4409-be74-af9ddc7c83ce", "remoteUpdatedAt": "2023-01-26T20:50:23Z", "remoteWasDeleted": false, "trackingCategories": [] }, "check_or_ach_number": null, "total_amount_with_fees": null } }, "table": "payments", "webhookSubscriptionId": "whs_example", "resourceId": "pym_example", "retryOfId": null, "retries": [] } }, "ShipmentDocumentsInsertEventExample": { "value": { "id": "whe_example", "createdAt": "2024-12-10T13:48:31-08:00", "updatedAt": "2024-12-10T13:48:31-08:00", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "INSERT", "payload": { "new": { "documents": [ { "id": "doc_example", "type": "SAMPLE_TYPE", "visibleToCustomer": true, "visibleToCarrier": false } ], "shipment": { "id": "shipment_example", "number": "1234" }, "file": { "id": "file_example", "filename": "filename_example", "url": "url_example" }, "created_at": "2024-11-17T18:38:29.405283", "updated_at": "2024-11-17T22:12:44.900167" }, "old": null }, "table": "shipment_documents", "webhookSubscriptionId": "whs_example", "resourceId": "cdoc_example", "retryOfId": null, "retries": [] } }, "ShipmentDocumentsUpdateEventExample": { "value": { "id": "whe_example", "createdAt": "2024-12-10T13:48:31-08:00", "updatedAt": "2024-12-10T13:48:31-08:00", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "documents": [ { "id": "doc_example", "type": "SAMPLE_TYPE", "visibleToCustomer": true, "visibleToCarrier": false } ], "shipment": { "id": "shipment_example", "number": "1234" }, "file": { "id": "file_example", "filename": "filename_example", "url": "url_example" }, "created_at": "2024-11-17T18:38:29.405283", "updated_at": "2024-11-17T22:12:44.900167" }, "old": { "documents": [ { "id": "doc_example", "type": "SAMPLE_TYPE", "visibleToCustomer": true, "visibleToCarrier": false } ], "shipment": { "id": "shipment_example", "number": "1234" }, "file": { "id": "file_example", "filename": "filename_example", "url": "url_example" }, "created_at": "2024-11-17T18:38:29.405283", "updated_at": "2024-11-17T22:12:44.900167" } }, "table": "shipment_documents", "webhookSubscriptionId": "whs_example", "resourceId": "cdoc_example", "retryOfId": null, "retries": [] } }, "ShipmentDocumentsDeleteEventExample": { "value": { "id": "whe_example", "createdAt": "2024-12-10T13:48:31-08:00", "updatedAt": "2024-12-10T13:48:31-08:00", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "DELETE", "payload": { "new": null, "old": { "documents": [ { "id": "doc_example", "type": "SAMPLE_TYPE", "visibleToCustomer": true, "visibleToCarrier": false } ], "shipment": { "id": "shipment_example", "number": "1234" }, "file": { "id": "file_example", "filename": "filename_example", "url": "url_example" }, "created_at": "2024-11-17T18:38:29.405283", "updated_at": "2024-11-17T22:12:44.900167" } }, "table": "shipment_documents", "webhookSubscriptionId": "whs_example", "resourceId": "cdoc_example", "retryOfId": null, "retries": [] } }, "InvoiceStatusSentEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T22:20:27.471642", "updatedAt": "2024-11-17T22:20:27.471642", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.status.SENT", "payload": { "new": { "id": "inv_example", "number": "1004", "status": "SENT", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-17T22:20:24.543408+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": true, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null }, "old": { "id": "inv_example", "number": "1004", "status": "PORTAL_EXCEPTION", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-17T22:17:10.963272+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": true, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null } }, "table": "invoices", "webhookSubscriptionId": "whs_example", "resourceId": "inv_example", "retryOfId": null, "retries": [] } }, "InvoiceStatusPortalExceptionEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T22:20:27.471642", "updatedAt": "2024-11-17T22:20:27.471642", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.status.PORTAL_EXCEPTION", "payload": { "new": { "id": "inv_example", "number": "1004", "status": "PORTAL_EXCEPTION", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-17T22:20:24.543408+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": true, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null }, "old": { "id": "inv_example", "number": "1004", "status": "SENT", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-17T22:17:10.963272+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": true, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null } }, "table": "invoices", "webhookSubscriptionId": "whs_example", "resourceId": "inv_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceStatusApprovedEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T22:41:42.392204", "updatedAt": "2024-11-17T22:41:42.392204", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.status.APPROVED", "payload": { "new": { "id": "cari_example", "status": "APPROVED", "balance": 213335, "bill_id": null, "currency": "USD", "due_date": "2024-11-22", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-08-28", "updated_at": "2024-11-17T22:41:38.698023+00:00", "load_number": "LOAD-2000", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 213335, "invoice_number": "2000", "total_tax_amount": 0, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "mergeId_placeholder", "remoteId": "remoteId_placeholder", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-10-27T21:01:26.843954", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null }, "old": { "id": "cari_example", "status": "RECEIVED", "balance": 213335, "bill_id": null, "currency": "USD", "due_date": "2024-11-22", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-08-28", "updated_at": "2024-11-16T00:59:33.492433+00:00", "load_number": "LOAD-2000", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 213335, "invoice_number": "2000", "total_tax_amount": "0", "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "mergeId_placeholder", "remoteId": "remoteId_placeholder", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-10-27T21:01:26.843954", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceStatusPortalExceptionEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T22:53:28.323541", "updatedAt": "2024-11-17T22:53:28.323541", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.status.EXCEPTION", "payload": { "new": { "id": "cari_example", "status": "EXCEPTION", "balance": 213335, "bill_id": null, "currency": "USD", "due_date": "2024-11-22", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-08-28", "updated_at": "2024-11-17T22:53:22.368671+00:00", "load_number": "LOAD-2000", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 213335, "invoice_number": "2000", "total_tax_amount": 0, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "mergeId_placeholder", "remoteId": "remoteId_placeholder", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-10-27T21:01:26.843954", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null }, "old": { "id": "cari_example", "status": "UNDER_REVIEW", "balance": 213335, "bill_id": null, "currency": "USD", "due_date": "2024-11-22", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-08-28", "updated_at": "2024-11-17T22:47:01.635235+00:00", "load_number": "LOAD-2000", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 213335, "invoice_number": "2000", "total_tax_amount": "0", "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "mergeId_placeholder", "remoteId": "remoteId_placeholder", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-10-27T21:01:26.843954", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceCrudEventExample": { "value": { "id": "whe_example", "createdAt": "2024-11-17T18:23:03.945732", "updatedAt": "2024-11-17T18:23:03.945732", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "id": "cari_example", "status": "RECEIVED", "balance": 250741, "bill_id": null, "currency": "EUR", "due_date": "2024-12-19", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-09-10", "updated_at": "2024-11-17T18:22:58.990876+00:00", "load_number": "LOAD-2343", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 250741, "invoice_number": "1027", "total_tax_amount": 0, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8", "remoteId": "75", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-26T20:54:08Z", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null }, "old": { "id": "cari_example", "status": "RECEIVED", "balance": 250741, "bill_id": null, "currency": "USD", "due_date": "2024-12-19", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-09-10", "updated_at": "2024-11-16T00:59:33.492433+00:00", "load_number": "LOAD-1027", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 250741, "invoice_number": "1027", "total_tax_amount": "0", "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8", "remoteId": "75", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-26T20:54:08Z", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceWebhookEventExample1": { "value": { "id": "whe_example", "createdAt": "2024-11-17T18:23:03.945732", "updatedAt": "2024-11-17T18:23:03.945732", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "id": "cari_example", "status": "RECEIVED", "balance": 250741, "bill_id": null, "currency": "EUR", "due_date": "2024-12-19", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-09-10", "updated_at": "2024-11-17T18:22:58.990876+00:00", "load_number": "LOAD-2343", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 250741, "invoice_number": "1027", "total_tax_amount": 0, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8", "remoteId": "75", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-26T20:54:08Z", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null }, "old": { "id": "cari_example", "status": "RECEIVED", "balance": 250741, "bill_id": null, "currency": "USD", "due_date": "2024-12-19", "metadata": null, "tenant_id": "ten_example", "carrier_id": "car_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "deleted_at": null, "issue_date": "2023-09-10", "updated_at": "2024-11-16T00:59:33.492433+00:00", "load_number": "LOAD-1027", "received_at": "2024-11-16T00:59:33.492433+00:00", "shipment_id": null, "total_amount": 250741, "invoice_number": "1027", "total_tax_amount": "0", "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_PAYABLE", "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8", "remoteId": "75", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-26T20:54:08Z", "remote_was_deleted": false, "tracking_categories": [] }, "customer_invoice_id": null, "created_from_email_message_id": null, "documents_type_or_customer_visibility_updated_at": null } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceShipmentCreateEventExample": { "value": { "id": "whe_example", "createdAt": "2024-12-10T14:16:44-08:00", "updatedAt": "2024-12-10T14:16:44-08:00", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.carrier_document.shipment_created", "payload": { "new": { "id": "cari_example", "tenant_id": "ten_example", "invoice_number": "INV123", "shipment": { "id": "ship_example", "shipment_number": "SHIP123", "carrier": "CARRIER_XYZ", "status": "CREATED", "pickup_date": "2024-12-09", "delivery_date": null } }, "old": { "id": "cari_example", "tenant_id": "ten_example", "invoice_number": "INV123", "shipment": null } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "CarrierInvoiceShipmentUpdateEventExample": { "value": { "id": "whe_example", "createdAt": "2024-12-10T14:16:44-08:00", "updatedAt": "2024-12-10T14:16:44-08:00", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE.carrier_document.shipment_updated", "payload": { "new": { "id": "cari_example", "tenant_id": "ten_example", "invoice_number": "INV123", "shipment": { "id": "ship_example", "shipment_number": "SHIP123", "carrier": "CARRIER_XYZ", "status": "DELIVERED", "pickup_date": "2024-12-09", "delivery_date": "2024-12-10" } }, "old": { "id": "cari_example", "tenant_id": "ten_example", "invoice_number": "INV123", "shipment": { "id": "ship_example", "shipment_number": "SHIP123", "carrier": "CARRIER_XYZ", "status": "IN_TRANSIT", "pickup_date": "2024-12-09", "delivery_date": null } } }, "table": "carrier_invoices", "webhookSubscriptionId": "whs_example", "resourceId": "cari_example", "retryOfId": null, "retries": [] } }, "InvoiceWebhookEventExample1": { "value": { "id": "whe_example", "createdAt": "2024-11-16T01:12:44.641898", "updatedAt": "2024-11-16T01:12:44.641898", "scheduledAt": null, "processedAt": null, "status": "PENDING", "operation": "UPDATE", "payload": { "new": { "id": "inv_example", "number": "1004", "status": "PAID", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-16T01:12:42.4475+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": true, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null }, "old": { "id": "inv_example", "number": "1004", "status": "PAID", "balance": 0, "sent_at": null, "currency": "USD", "due_date": "2024-10-23", "metadata": null, "ship_date": null, "tenant_id": "ten_example", "created_at": "2024-11-16T00:59:33.492433+00:00", "issue_date": "2023-09-15", "updated_at": "2024-11-16T00:59:33.492433+00:00", "customer_id": "cus_example", "portal_slug": "transporeon", "received_at": null, "statement_id": null, "total_amount": 236952, "delivery_date": null, "source_system": null, "hold_for_review": false, "company_division": null, "delivery_methods": [ "transporeon" ], "portal_exception": null, "source_system_id": null, "total_tax_amount": 17552, "debits_updated_at": null, "reference_numbers": null, "source_system_meta": { "type": "ACCOUNTS_RECEIVABLE", "mergeId": "1395f876-4e6e-4fad-88c2-1dd0ce401a1f", "remoteId": "12", "field_mappings": { "organization_defined_targets": null, "linked_account_defined_targets": null }, "remote_updated_at": "2023-01-27T20:59:21Z", "remote_was_deleted": false, "tracking_categories": [] }, "document_exceptions": null, "sent_to_portal_slug": null, "scheduled_payment_date": null, "invoice_creation_event_id": null, "received_from_portal_slug": "transporeon", "line_items_last_updated_at": "2024-11-16T00:59:33.492433+00:00", "file_associations_updated_at": null, "created_from_email_message_id": null } }, "table": "invoices", "webhookSubscriptionId": "whs_example", "resourceId": "inv_example", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-Create": { "value": { "id": "whe_cr123456", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "create.remittance", "operation": "INSERT", "payload": { "remittance": { "id": "remi_new123", "type": "pdf", "status": "pending", "currency": "USD", "metadata": { "comment": "New remittance created" }, "filePath": null, "syncedAt": null, "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T19:07:27.894052", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-456", "sourceCompany": "AeroTrade", "totalAmountPaid": 50000, "checkOrAchNumber": null, "totalAmountBilled": 50000, "totalDiscountAmount": null, "lineItems": [ { "id": "rli_newitem1", "comments": null, "createdAt": "2025-04-30T19:07:27.894052", "currency": "USD", "customerDocumentNumber": "2001", "discountAmount": null, "grossAmountBilled": null, "invoiceDate": "2023-09-08", "invoiceNumber": "2001", "metadata": null, "netAmountPaid": 50000, "remittanceId": "remi_new123", "status": null, "updatedAt": "2025-04-30T19:07:27.894052" } ] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_new123", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-Delete": { "value": { "id": "whe_del123456", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "delete.remittance", "operation": "DELETE", "payload": { "remittance": { "id": "remi_del123", "type": "pdf", "status": "deleted", "currency": "USD", "metadata": { "comment": "Remittance deleted" }, "filePath": null, "syncedAt": "2025-04-30T19:09:02.344", "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T21:15:45.987654", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-789", "sourceCompany": "AeroTrade", "totalAmountPaid": 75000, "checkOrAchNumber": null, "totalAmountBilled": 75000, "totalDiscountAmount": null, "lineItems": [] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_del123", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-Pending": { "value": { "id": "whe_pen123456", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "update.remittance.status.pending", "operation": "UPDATE", "payload": { "remittance": { "id": "remi_j1Fb4hW7", "type": "pdf", "status": "pending", "currency": "USD", "metadata": { "comment": "Remittance status set to pending" }, "filePath": null, "syncedAt": "2025-04-30T19:09:02.344", "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T19:07:27.894052", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-123", "sourceCompany": "AeroTrade", "totalAmountPaid": 123894, "checkOrAchNumber": null, "totalAmountBilled": 124644, "totalDiscountAmount": null, "lineItems": [ { "id": "rli_clpiuSGX", "comments": null, "createdAt": "2025-04-30T19:07:27.894052", "currency": "USD", "customerDocumentNumber": "1016", "discountAmount": null, "grossAmountBilled": null, "invoiceDate": "2023-09-08", "invoiceNumber": "1016", "metadata": null, "netAmountPaid": 123894, "remittanceId": "remi_j1Fb4hW7", "status": null, "updatedAt": "2025-04-30T19:07:27.894052" } ] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_j1Fb4hW7", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-Succeeded": { "value": { "id": "whe_suc123456", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "update.remittance.status.succeeded", "operation": "UPDATE", "payload": { "remittance": { "id": "remi_j1Fb4hW7", "type": "pdf", "status": "succeeded", "currency": "USD", "metadata": { "comment": "Remittance processing succeeded" }, "filePath": null, "syncedAt": "2025-04-30T22:30:15.567890", "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T22:30:15.567890", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-123", "sourceCompany": "AeroTrade", "totalAmountPaid": 123894, "checkOrAchNumber": null, "totalAmountBilled": 124644, "totalDiscountAmount": null, "lineItems": [ { "id": "rli_clpiuSGX", "comments": null, "createdAt": "2025-04-30T19:07:27.894052", "currency": "USD", "customerDocumentNumber": "1016", "discountAmount": null, "grossAmountBilled": null, "invoiceDate": "2023-09-08", "invoiceNumber": "1016", "metadata": null, "netAmountPaid": 123894, "remittanceId": "remi_j1Fb4hW7", "status": "succeeded", "updatedAt": "2025-04-30T22:30:15.567890" } ] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_j1Fb4hW7", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-SyncError": { "value": { "id": "whe_oFKg0DfG", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "update.remittance.status.sync_error", "operation": "UPDATE", "payload": { "remittance": { "id": "remi_j1Fb4hW7", "type": "pdf", "status": "sync_error", "currency": "USD", "metadata": { "comment": "Test reconcliation tolerances. Difference is $7.50" }, "filePath": null, "syncedAt": "2025-04-30T19:09:02.344", "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T19:07:27.894052", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-123", "sourceCompany": "AeroTrade", "totalAmountPaid": 123894, "checkOrAchNumber": null, "totalAmountBilled": 124644, "totalDiscountAmount": null, "lineItems": [ { "id": "rli_clpiuSGX", "comments": null, "createdAt": "2025-04-30T19:07:27.894052", "currency": "USD", "customerDocumentNumber": "1016", "discountAmount": null, "grossAmountBilled": null, "invoiceDate": "2023-09-08", "invoiceNumber": "1016", "metadata": null, "netAmountPaid": 123894, "remittanceId": "remi_j1Fb4hW7", "status": null, "updatedAt": "2025-04-30T19:07:27.894052" } ] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_j1Fb4hW7", "retryOfId": null, "retries": [] } }, "RemittanceWebhookEventExample-Update": { "value": { "id": "whe_up123456", "createdAt": "2025-04-28T19:05:17.171569", "updatedAt": "2025-04-28T19:05:17.171569", "scheduledAt": null, "processedAt": null, "status": "PENDING", "trigger": "update.remittance", "operation": "UPDATE", "payload": { "remittance": { "id": "remi_j1Fb4hW7", "type": "pdf", "status": "pending", "currency": "USD", "metadata": { "comment": "Remittance details updated" }, "filePath": null, "syncedAt": "2025-04-30T19:09:02.344", "createdAt": "2025-04-30T19:07:27.894052", "updatedAt": "2025-04-30T20:10:30.123456", "customerId": "cus_6ZSYs5Kd", "batchNumber": null, "paymentDate": "2024-04-08", "paymentMethod": "ACH", "paymentNumber": "TEST-ACH-123", "sourceCompany": "AeroTrade", "totalAmountPaid": 123894, "checkOrAchNumber": null, "totalAmountBilled": 124644, "totalDiscountAmount": null, "lineItems": [ { "id": "rli_clpiuSGX", "comments": "Updated payment details", "createdAt": "2025-04-30T19:07:27.894052", "currency": "USD", "customerDocumentNumber": "1016", "discountAmount": null, "grossAmountBilled": null, "invoiceDate": "2023-09-08", "invoiceNumber": "1016", "metadata": null, "netAmountPaid": 123894, "remittanceId": "remi_j1Fb4hW7", "status": null, "updatedAt": "2025-04-30T20:10:30.123456" } ] } }, "table": "remittances", "webhookSubscriptionId": "whs_w9wlR4DC", "resourceId": "remi_j1Fb4hW7", "retryOfId": null, "retries": [] } } } }, "openapi": "3.1.0", "servers": [ { "url": "https://api.upwell.com", "description": "Production server" }, { "url": "https://staging.api.upwell.com", "description": "Staging server" } ], "tags": [ { "name": "Invoice Approval", "description": "Endpoints for managing customer invoice approval workflow" } ], "webhooks": { "onCarrierInvoiceEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle carrier invoice events", "description": "Triggered when a carrier invoice record is created, updated, or deleted", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierInvoiceWebhookEvent" }, "examples": { "example1": { "$ref": "#/components/examples/CarrierInvoiceWebhookEventExample1" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onCarrierInvoiceStatusApprovedEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle carrier invoice status approved events", "description": "Triggered when the `status` of a carrier invoice record is updated to `approved`.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldSpecificUpdateEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/CarrierInvoiceStatusApprovedEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onCarrierInvoiceStatusPortalExceptionEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle carrier invoice status portal exception events", "description": "Triggered when the `status` of a carrier invoice record is updated to `portal_exception`.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldSpecificUpdateEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/CarrierInvoiceStatusPortalExceptionEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onCarrierInvoiceUpdateShipmentCreatedEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle carrier invoice shipment creation events", "description": "Triggered when a carrier invoice is linked to a newly created shipment", "requestBody": { "description": "Details of the carrier invoice shipment creation", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrudEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/CarrierInvoiceShipmentCreateEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onCarrierInvoiceUpdateShipmentUpdatedEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle carrier invoice shipment update events", "description": "Triggered when a carrier invoice's shipment information is updated", "requestBody": { "description": "Details of the carrier invoice shipment update", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrudEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/CarrierInvoiceShipmentUpdateEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onCustomerPaymentsEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle payments events", "description": "Triggered when a payments record is created, updated, or deleted.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrudEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/CustomerPaymentsCrudEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onInvoiceEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handles invoice events", "description": "Triggered when an invoice record is created, updated, or deleted.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceWebhookEvent" }, "examples": { "example1": { "$ref": "#/components/examples/InvoiceWebhookEventExample1" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onInvoiceStatusPortalExceptionEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle invoice status portal exception events", "description": "Triggered when the `status` of an invoice record is updated to `portal_exception`.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldSpecificUpdateEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/InvoiceStatusPortalExceptionEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onInvoiceStatusSentEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle invoice status sent events", "description": "Triggered when the `status` of an invoice record is updated to `sent`.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldSpecificUpdateEventRequest" }, "examples": { "example1": { "$ref": "#/components/examples/InvoiceStatusSentEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onRemittanceEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handles remittance events", "description": "Triggered when a remittance record is created, updated, or deleted.", "requestBody": { "description": "Details that are sent over to the webhook", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemittanceWebhookEvent" }, "examples": { "status: sync_error": { "$ref": "#/components/examples/RemittanceWebhookEventExample-SyncError" }, "create": { "$ref": "#/components/examples/RemittanceWebhookEventExample-Create" }, "update": { "$ref": "#/components/examples/RemittanceWebhookEventExample-Update" }, "delete": { "$ref": "#/components/examples/RemittanceWebhookEventExample-Delete" }, "status: pending": { "$ref": "#/components/examples/RemittanceWebhookEventExample-Pending" }, "status: succeeded": { "$ref": "#/components/examples/RemittanceWebhookEventExample-Succeeded" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } }, "onShipmentDocumentsEvent": { "post": { "tags": [ "Webhooks" ], "summary": "Handle shipment documents events", "description": "Triggered when a shipment document file associations record is created, updated, or deleted.", "requestBody": { "description": "Details of the shipment document file associations event", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CrudEventRequest" }, "examples": { "INSERT": { "$ref": "#/components/examples/ShipmentDocumentsInsertEventExample" }, "UPDATE": { "$ref": "#/components/examples/ShipmentDocumentsUpdateEventExample" }, "DELETE": { "$ref": "#/components/examples/ShipmentDocumentsDeleteEventExample" } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-mint": { "metadata": { "public": true } } } } } }