{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"servers":[{"url":"https://axigrate.mml.co.za","description":"Generated server url"}],"tags":[{"name":"Authentication API","description":"Operations related to authentication."},{"name":"Accounting API","description":"Operations related to accounting."},{"name":"Sales API","description":"Operations related to sales."},{"name":"Purchasing API","description":"Operations related to purchasing. This API is work-in-progress"},{"name":"DSV Webhooks API","description":"Operations related to receiving DSV Webhook push notifications."},{"name":"Test API","description":"Operations related to dev testing."},{"name":"DSV Admin API","description":"Administrative operations for DSV Contract Logistics integration."}],"paths":{"/jwt/authenticate":{"post":{"tags":["Authentication API"],"summary":"Authenticate your requests. Get a token.","description":"Authenticate your requests. Get a token, login using this request, providing your user name and password. This user name and password will be issued to you by the customer. Using this request, you will receive a token that may be used in the header for application requests. This token is valid for 24hours. Repeat this call to renew your token.\n\nExample using curl;\n\ncurl -X POST 'http://axigrate_host:8181/jwt/authenticate'\n\t-H 'Content-Type: application/json'\n\t-d '{ \"username\": \"your_axigrate_username\", \"password\": \"your_axigrate_password\" }'\n\n
","operationId":"createAuthenticationToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/webhook/dsv/receipt-confirmation":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSReceiptConfirmation webhook.","description":"Receives a receipt confirmation payload from DSV when an inbound is received.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/receipt-confirmation\n\t-H \"Content-Type: application/json\"\n\t-d '{\"inboundId\": \"...\"}'\n\n
\n","operationId":"handleReceiptConfirmation","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/webhook/dsv/order-status-change":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSOrderStatusChange webhook.","description":"Receives an order status change payload from DSV.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/order-status-change\n\t-H \"Content-Type: application/json\"\n\t-d '{\"deliveryId\": \"...\"}'\n\n
\n","operationId":"handleOrderStatusChange","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/webhook/dsv/inventory-full":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSInventoryFull webhook.","description":"Receives a full inventory payload from DSV.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/inventory-full\n\t-H \"Content-Type: application/json\"\n\t-d '{\"warehouseId\": \"...\"}'\n\n
\n","operationId":"handleInventoryFull","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/webhook/dsv/inventory-change":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSInventoryChange webhook.","description":"Receives an inventory change payload from DSV.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/inventory-change\n\t-H \"Content-Type: application/json\"\n\t-d '{\"productId\": \"...\"}'\n\n
\n","operationId":"handleInventoryChange","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/webhook/dsv/inbound-status-change":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSInboundNotificationStatusChange webhook.","description":"Receives an inbound notification status change payload from DSV.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/inbound-status-change\n\t-H \"Content-Type: application/json\"\n\t-d '{\"inboundId\": \"...\"}'\n\n
\n","operationId":"handleInboundStatusChange","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/webhook/dsv/delivery-confirmation":{"post":{"tags":["DSV Webhooks API"],"summary":"Handle DSV WMSDeliveryConfirmation webhook.","description":"Receives a delivery confirmation payload from DSV when an order ships.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/webhook/dsv/delivery-confirmation\n\t-H \"Content-Type: application/json\"\n\t-d '{\"deliveryId\": \"...\"}'\n\n
\n","operationId":"handleDeliveryConfirmation","requestBody":{"content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}},"required":true},"responses":{"200":{"description":"Success"}}}},"/api/test/send/mail":{"post":{"tags":["Test API"],"operationId":"sendEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/test/send/jms":{"post":{"tags":["Test API"],"operationId":"sendMessage","requestBody":{"content":{"application/json":{"schema":{"type":"string"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/test/send/jms0":{"post":{"tags":["Test API"],"operationId":"sendMessage0","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnExampleGenericMessageString"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/test/dsv/processStockRecon":{"post":{"tags":["Test API"],"summary":"Execute DsvScheduledTask.processDsvFunctions on demand.","description":"Bypasses the cron schedule and kicks off the DSV stock recon processing in the background, returning immediately instead of blocking the caller for the duration of the run. Only available when the mml_mml, mml_mmt or mml_mx2 profile is active, since DsvScheduledTask is only registered as a bean under those profiles.","operationId":"processStockRecon","responses":{"202":{"description":"Accepted, processing started in the background","content":{"*/*":{"schema":{"type":"string"}}}},"404":{"description":"DsvScheduledTask not available for the active profile"}}}},"/api/test/cache/users/reload":{"post":{"tags":["Test API"],"operationId":"reloadUsersCache","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserImpl"}}}}}}}},"/api/test/cache/users/evict":{"post":{"tags":["Test API"],"operationId":"evictUsersCache","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/sales/order/update":{"post":{"tags":["Sales API"],"summary":"Update a sales order. (not used)","description":"Update a sales order. Supply only the lines that are changing. The example below updates two lines of Exclusive Books order EB-16847 - line 20 goes from 2 to 4, and line 40 goes from 2 to 3.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/order/update\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"accountNumber\": \"0000510788\",\n\t\t\"carrierCode\": \"**\",\n\t\t\"customerReference\": \"16847\",\n\t\t\"deliveryName\": \"EXCLUSIVE BOOKS MALL OF AFRICA\",\n\t\t\"deliveryAddress1\": \"EXCLUSIVE BOOKS GROUP(PTY)LTD\",\n\t\t\"deliveryAddress2\": \"SHOP 2127 MALL OF AFRICA\",\n\t\t\"deliveryAddress3\": \"MAGWA CRESCENT\",\n\t\t\"deliveryAddress4\": \"WATERFALL CITY\",\n\t\t\"deliveryAddress5\": \"1682\",\n\t\t\"deliveryAddress6\": \"SOUTH AFRICA\",\n\t\t\"standardAccountNumber\": \"5030670179893\",\n\t\t\"partialDelivery\": \"Y\",\n\t\t\"phoneNumber\": \"011 798 0000\",\n\t\t\"faxNumber\": \"011 803 0002\",\n\t\t\"salesOrderLineUpdateRequests\": [\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9781861974044\",\n\t\t\t\t\"orderLineNumber\": 20,\n\t\t\t\t\"orderQuantity\": 4,\n\t\t\t\t\"salesOrderLineTextUpdateRequests\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"orderTextLineNumber\": 1,\n\t\t\t\t\t\t\"textType\": \"DTL\",\n\t\t\t\t\t\t\"text\": \"QUANTITY INCREASED ON CUSTOMER REQUEST\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9780007420124\",\n\t\t\t\t\"orderLineNumber\": 40,\n\t\t\t\t\"orderQuantity\": 3\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"orderUpdate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesOrderUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/order/return":{"post":{"tags":["Sales API"],"summary":"Return a sales order.","description":"Raise a claim/return against goods previously supplied. The example below returns two lines of Exclusive Books order EB-16847, lines 30 and 50.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/order/return\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"accountNumber\": \"0000510788\",\n\t\t\"customerReference\": \"16847\",\n\t\t\"replyTo\": \"returns@exclusivebooks.co.za\",\n\t\t\"salesOrderReturnLineCreateRequests\": [\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9780008507237\",\n\t\t\t\t\"lineNumber\": 30,\n\t\t\t\t\"quantity\": 1,\n\t\t\t\t\"reasonCode\": \"01\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9780349439259\",\n\t\t\t\t\"lineNumber\": 50,\n\t\t\t\t\"quantity\": 2,\n\t\t\t\t\"reasonCode\": \"01\"\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"orderReturn","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesOrderReturnCreateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/order/create":{"post":{"tags":["Sales API"],"summary":"Create a sales order.","description":"Create a sales order. The example below is Exclusive Books order EB-16847, on account 0000510788.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/order/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"carrierCode\": \"**\",\n\t\t\"accountNumber\": \"0000510788\",\n\t\t\"customerReference\": \"16847\",\n\t\t\"customerReferenceDate\": \"2026-07-22\",\n\t\t\"deliveryName\": \"EXCLUSIVE BOOKS MALL OF AFRICA\",\n\t\t\"deliveryAddress1\": \"EXCLUSIVE BOOKS GROUP(PTY)LTD\",\n\t\t\"deliveryAddress2\": \"SHOP 2127 MALL OF AFRICA\",\n\t\t\"deliveryAddress3\": \"MAGWA CRESCENT\",\n\t\t\"deliveryAddress4\": \"WATERFALL CITY\",\n\t\t\"deliveryAddress5\": \"1682\",\n\t\t\"deliveryAddress6\": \"SOUTH AFRICA\",\n\t\t\"standardAccountNumber\": \"5030670179893\",\n\t\t\"emailAddress\": \"MALLOFAFRICA.RETURNS@EXCLUSIVEBOOKS.CO.ZA\",\n\t\t\"specialInstructions1\": \"DELIVER TO RECEIVING - SHOP 2127\",\n\t\t\"specialInstructions2\": \"CALL STORE ON ARRIVAL\",\n\t\t\"sourceOfOrder\": \"EB\",\n\t\t\"partialDelivery\": \"Y\",\n\t\t\"salesOrderBillingCreateRequest\": {\n\t\t\t\"billingCustomerName\": \"EXCLUSIVE BOOKS GROUP(PTY)LTD\",\n\t\t\t\"billingAddress1\": \"PO BOX 605\",\n\t\t\t\"billingAddress2\": \"\",\n\t\t\t\"billingAddress3\": \"\",\n\t\t\t\"billingAddress4\": \"RIVONIA\",\n\t\t\t\"billingAddress5\": \"2128\",\n\t\t\t\"billingAddress6\": \"SOUTH AFRICA\",\n\t\t\t\"billingPhoneNumber\": \"011 798 0000\",\n\t\t\t\"billingFaxNumber\": \"011 803 0002\"\n\t\t},\n\t\t\"salesOrderLineTextCreateRequests\": [\n\t\t\t{\n\t\t\t\t\"orderTextLineNumber\": 1,\n\t\t\t\t\"textType\": \"DTL\",\n\t\t\t\t\"text\": \"ORDER RAISED BY STORE 2127\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"orderTextLineNumber\": 2,\n\t\t\t\t\"textType\": \"DTL\",\n\t\t\t\t\"text\": \"CONSOLIDATE WITH OTHER OUTSTANDING ORDERS\"\n\t\t\t}\n\t\t],\n\t\t\"salesOrderLineCreateRequests\": [\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9781861979988\",\n\t\t\t\t\"orderLineNumber\": 10,\n\t\t\t\t\"orderQuantity\": 1,\n\t\t\t\t\"unitPrice\": 195.00,\n\t\t\t\t\"itemDescription\": \"CONCISE 33 STRATEGIES OF WAR PB\",\n\t\t\t\t\"itemBarcode\": \"9781861979988\",\n\t\t\t\t\"netPriceFlag\": \"Y\",\n\t\t\t\t\"salesOrderLineTextCreateRequests\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"orderTextLineNumber\": 1,\n\t\t\t\t\t\t\"textType\": \"DTL\",\n\t\t\t\t\t\t\"text\": \"GIFT WRAP THIS TITLE\"\n\t\t\t\t\t}\n\t\t\t\t]\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9781861974044\",\n\t\t\t\t\"orderLineNumber\": 20,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 120.45,\n\t\t\t\t\"itemDescription\": \"CONCISE 48 LAWS OF POWER PB\",\n\t\t\t\t\"itemBarcode\": \"9781861974044\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780008507237\",\n\t\t\t\t\"orderLineNumber\": 30,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 87.45,\n\t\t\t\t\"itemDescription\": \"FIVE SURVIVE PB\",\n\t\t\t\t\"itemBarcode\": \"9780008507237\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780007420124\",\n\t\t\t\t\"orderLineNumber\": 40,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 72.00,\n\t\t\t\t\"itemDescription\": \"COLL CLASSICS ART OF WAR APB\",\n\t\t\t\t\"itemBarcode\": \"9780007420124\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780349439259\",\n\t\t\t\t\"orderLineNumber\": 50,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 195.00,\n\t\t\t\t\"itemDescription\": \"BOYS OF TOMMEN 1: BINDING 13 BPB\",\n\t\t\t\t\"itemBarcode\": \"9780349439259\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780349439273\",\n\t\t\t\t\"orderLineNumber\": 60,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 195.00,\n\t\t\t\t\"itemDescription\": \"BOYS OF TOMMEN 2: KEEPING 13 BPB\",\n\t\t\t\t\"itemBarcode\": \"9780349439273\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780349439358\",\n\t\t\t\t\"orderLineNumber\": 70,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 107.25,\n\t\t\t\t\"itemDescription\": \"BOYS OF TOMMEN 5: TAMING 7 BPB\",\n\t\t\t\t\"itemBarcode\": \"9780349439358\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"despatchDate\": \"2026-07-23\",\n\t\t\t\t\"itemCode\": \"9780008619978\",\n\t\t\t\t\"orderLineNumber\": 80,\n\t\t\t\t\"orderQuantity\": 2,\n\t\t\t\t\"unitPrice\": 66.00,\n\t\t\t\t\"itemDescription\": \"COLL CLASSICS COMMUNIST MANIFESTO PB\",\n\t\t\t\t\"itemBarcode\": \"9780008619978\",\n\t\t\t\t\"netPriceFlag\": \"Y\"\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"orderCreate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesOrderCreateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/order/cancel":{"post":{"tags":["Sales API"],"summary":"Cancel a sales order. (not used)","description":"Cancel a sales order. Supply salesOrderLineCancelRequests to cancel individual lines, or omit it to cancel the whole order. The example below cancels two lines of Exclusive Books order EB-16847, lines 60 and 70.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/order/cancel\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"accountNumber\": \"0000510788\",\n\t\t\"customerReference\": \"16847\",\n\t\t\"reason\": \"CUSTOMER CANCELLED - TITLES NO LONGER REQUIRED\",\n\t\t\"salesOrderLineCancelRequests\": [\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9780349439273\",\n\t\t\t\t\"orderLineNumber\": 60\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"itemCode\": \"9780349439358\",\n\t\t\t\t\"orderLineNumber\": 70\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"orderCancel","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesOrderCancelRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/item/update":{"post":{"tags":["Sales API"],"summary":"Update a sales item\\product\\isbn.","description":"Update a sales item\\product\\isbn.\n\nExamples using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/item/update\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"itemCode\": \"9781861974044\",\n\t\t\"itemDescription\": \"CONCISE 48 LAWS OF POWER PB\",\n\t\t\"itemBarcode\": \"9781861974044\"\n\t}'\n\n
\n","operationId":"itemUpdate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemChangeRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/item/send/productCatalog":{"post":{"tags":["Sales API"],"summary":"Manually trigger the sending of the sales item\\product\\isbn predefined catalogue list to the client.","description":"Manually trigger the sending of the sales item\\product\\isbn predefined catalogue list to the client.\n\nExample using curls;\ncurl -X POST 'http://axigrate_host:8181/api/sales/item/send/productCatalog'\n\t-H 'Content-Type: application/json'\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\"identifier\": \"AH6SO\", \"storeCode\": \"AMZ\" }'\n\n\ncurl -X POST 'http://axigrate_host:8181/api/sales/item/send/productCatalog'\n\t-H 'Content-Type: application/json'\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{ \"identifier\": \"NBPUC\", \"storeCode\": \"AMZ\" }'\n\n\ncurl -X POST 'http://axigrate_host:8181/api/sales/item/send/productCatalog'\n\t-H 'Content-Type: application/json'\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\"identifier\": \"6Z7MS\", \"storeCode\": \"AMZ\" }'\n\n
\n","operationId":"sendProductCatalog","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductCatalogSendRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/item/create":{"post":{"tags":["Sales API"],"summary":"Create one or more sales items\\products\\isbns.","description":"Create one or more sales items\\products\\isbns. The request body is a JSON array of item create requests.\n\nExamples using curl;\n\ncurl -X POST http://axigrate_host:8181/api/sales/item/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '[\n\t\t{\n\t\t\t\"itemCode\": \"9781861979988\",\n\t\t\t\"itemDescription\": \"CONCISE 33 STRATEGIES OF WAR PB\",\n\t\t\t\"categoryL1\": \"040\",\n\t\t\t\"categoryL2\": \"K91\",\n\t\t\t\"categoryL3\": \"990\",\n\t\t\t\"categoryL4\": \"700\",\n\t\t\t\"categoryL5\": \"752\",\n\t\t\t\"currencyCode\": \"P\",\n\t\t\t\"unitOfMeasure\": \"\",\n\t\t\t\"itemBarcode\": \"9781861979988\",\n\t\t\t\"alternateItemCode\": \"1861979983\",\n\t\t\t\"supplierItemCode\": \"\",\n\t\t\t\"packItem\": \"N\"\n\t\t},\n\t\t{\n\t\t\t\"itemCode\": \"9781861974044\",\n\t\t\t\"itemDescription\": \"CONCISE 48 LAWS OF POWER PB\",\n\t\t\t\"categoryL1\": \"040\",\n\t\t\t\"categoryL2\": \"K91\",\n\t\t\t\"categoryL3\": \"990\",\n\t\t\t\"categoryL4\": \"700\",\n\t\t\t\"categoryL5\": \"752\",\n\t\t\t\"currencyCode\": \"P\",\n\t\t\t\"unitOfMeasure\": \"\",\n\t\t\t\"itemBarcode\": \"9781861974044\",\n\t\t\t\"alternateItemCode\": \"1861974043\",\n\t\t\t\"supplierItemCode\": \"\",\n\t\t\t\"packItem\": \"N\"\n\t\t}\n\t]'\n\nA PRH item, using the optional fields of the PAN/PRH item templates;\n\ncurl -X POST http://axigrate_host:8181/api/sales/item/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '[\n\t\t{\n\t\t\t\"itemCode\": \"9780091891619\",\n\t\t\t\"itemDescription\": \"MANAGE YOUR STUDENT FINANCES NOW!\",\n\t\t\t\"author\": \"PHILLIPS, KATE\",\n\t\t\t\"itemLongDescription\": \"MANAGE YOUR STUDENT FINANCES NOW!: BALANCING THE BUDGET AT UNIVERSITY AND COLLEGE\",\n\t\t\t\"categoryL1\": \"PRH\",\n\t\t\t\"categoryL2\": \"RAN\",\n\t\t\t\"categoryL3\": \"RUK\",\n\t\t\t\"categoryL4\": \"REB\",\n\t\t\t\"categoryL5\": \"ZND\",\n\t\t\t\"currencyCode\": \"P\",\n\t\t\t\"itemBarcode\": \"9780091891619\",\n\t\t\t\"supplierItemCode\": \"\",\n\t\t\t\"packItem\": \"N\",\n\t\t\t\"stockReport\": \"\",\n\t\t\t\"brandCode\": \"EBU\",\n\t\t\t\"binding\": \"PB\",\n\t\t\t\"packagingType\": \"\",\n\t\t\t\"overseasReleaseDate\": \"2026-07-01\",\n\t\t\t\"abcClass\": \"A\",\n\t\t\t\"stockItem\": \"Y\",\n\t\t\t\"buyingPrice\": 12.99,\n\t\t\t\"supplierDiscount\": 52.50,\n\t\t\t\"overseasPrice\": 12.99,\n\t\t\t\"rrp\": 350.00,\n\t\t\t\"stockStatus\": \"\",\n\t\t\t\"releaseDate\": \"2026-08-01\",\n\t\t\t\"firmSale\": \"N\",\n\t\t\t\"linkItemCode\": \"\",\n\t\t\t\"catalogueId\": \"F#RANGENERAL FICTION\",\n\t\t\t\"itemClassifications\": [\n\t\t\t\t{ \"type\": \"IC-WEBD\", \"code\": \"Y\" },\n\t\t\t\t{ \"type\": \"IC-LNG\", \"code\": \"ENG\" }\n\t\t\t]\n\t\t}\n\t]'\n\n
\n","operationId":"itemCreate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ItemCreateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/purchasing/receive/poack":{"post":{"tags":["Purchasing API"],"summary":"Receive a purchase order acknowledgement. (not used)","description":"Receive a purchase order acknowledgement.","operationId":"receivePurchaseOrderAck","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"404":{"description":"Error"}}}},"/api/admin/dsv/stock-recon":{"post":{"tags":["DSV Admin API"],"summary":"DSV-CLIENT Stock Reconciliation.","description":"Upload a DSV INVRPT XML file and reconcile each SKU against the CLIENT Bookmaster warehouse (dswh00p / dsim00p). Email an Excel report with per-SKU ISBN, Title, DSV SOH, CLIENT SOH, Variance, and DSV Location.\n\n\nExample using curl;\n\ncurl -X POST \"http://axigrate_host:8181/api/admin/dsv/stock-recon\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\t-F \"file=@/path/to/INVRPT_file.xml\"\n\n
\n","operationId":"processStockRecon_1","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"DSV INVRPT XML file to reconcile (if multipart)","format":"binary"}}}},"application/xml":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"DSV INVRPT XML file to reconcile (if multipart)","format":"binary"}}}},"text/xml":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"DSV INVRPT XML file to reconcile (if multipart)","format":"binary"}}}},"application/octet-stream":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"DSV INVRPT XML file to reconcile (if multipart)","format":"binary"}}}}}},"responses":{"200":{"description":"Reconciliation completed successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AResponse"}}}},"400":{"description":"Bad Request — invalid or missing XML file"},"500":{"description":"Internal Server Error"}}}},"/api/admin/dsv/register-webhooks":{"post":{"tags":["DSV Admin API"],"summary":"Manually trigger DSV Webhook Registration.","description":"Register the application's endpoints to receive DSV webhook events.\n\n\nExample using curl;\n\ncurl -X POST \"http://axigrate_host:8181/api/admin/dsv/register-webhooks?baseCallbackUrl=https://196.22.240.122:443\"\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\n
\n","operationId":"triggerWebhookRegistration","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"baseCallbackUrl","in":"query","description":"The base callback URL to register for webhooks","required":false,"schema":{"type":"string","default":"https://196.22.240.122:443"},"example":"http://axigrate_host:8181"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"400":{"description":"Bad Request"}}}},"/api/accounting/gl/journalEntry/create":{"post":{"tags":["Accounting API"],"summary":"Submit a batch of GL journal entries.","description":"Submit a batch of GL journal entries.\n eg. from a third-party payroll system. The entries of a batch must balance, ie. the amounts must sum to zero. The example below is journal GA000259, a 21 line provision journal that balances back to the control account on line 21.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/accounting/gl/journalEntry/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"sourceId\": \"vip\",\n\t\t\"journalEntries\": [\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005001\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 4234.81,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 4234.81,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 1\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005003\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 27704.58,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 27704.58,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 2\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005004\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 52309.01,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 52309.01,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 3\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005005\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 39568.34,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 39568.34,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 4\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005012\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 7693.31,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 7693.31,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 5\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005013\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 3169.65,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 3169.65,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 6\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005021\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 36040.62,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 36040.62,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 7\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005022\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 15352.34,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 15352.34,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 8\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005023\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 20534.50,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 20534.50,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 9\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005030\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 31546.19,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 31546.19,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 10\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"005031\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 40510.60,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 40510.60,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 11\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006003\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 77280.94,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 77280.94,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 12\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006004\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 29247.91,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 29247.91,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 13\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006005\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 1000.41,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 1000.41,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 14\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006008\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 39279.30,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 39279.30,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 15\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006009\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 28397.85,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 28397.85,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 16\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006012\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 14880.18,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 14880.18,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 17\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006024\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": -3001.89,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": -3001.89,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 18\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"007001\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 8998.02,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 8998.02,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 19\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"011008\",\n\t\t\t\t\"glAccountMajor\": \"38911\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": 74626.75,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": 74626.75,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 20\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t},\n\t\t\t{\n\t\t\t\t\"profitCentre\": \"006001\",\n\t\t\t\t\"glAccountMajor\": \"51600\",\n\t\t\t\t\"glAccountMinor\": \"\",\n\t\t\t\t\"amount\": -549373.42,\n\t\t\t\t\"currencyExchangeCode\": \"R\",\n\t\t\t\t\"foreignAmount\": -549373.42,\n\t\t\t\t\"journalEntryId\": {\n\t\t\t\t\t\"glCompany\": \"01\",\n\t\t\t\t\t\"journalType\": \"G\",\n\t\t\t\t\t\"journalNumber\": \"GA000259\",\n\t\t\t\t\t\"lineNumber\": 21\n\t\t\t\t},\n\t\t\t\t\"journalEntryDescription\": \"PROV DDC CHARGE JUN'\"\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"journalEntryCreate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GLJournalCreateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/supplier/update":{"post":{"tags":["Accounting API"],"summary":"Update one or more accounts payable suppliers.","description":"Update one or more accounts payable suppliers (creditors). The request body is a JSON array of supplier update requests. The first example is creditor 00145, HarperCollins USA.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/accounting/ap/supplier/update\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\t-d '[\n\t\t{\n\t\t\t\"sourceId\": \"acumatica\",\n\t\t\t\"creditorNumber\": \"00145\",\n\t\t\t\"creditorName\": \"HARPERCOLLINS USA\",\n\t\t\t\"creditorAddress0\": \"\",\n\t\t\t\"creditorAddress1\": \"KEYSTONE INDUSTRIAL PARK\",\n\t\t\t\"creditorAddress2\": \"SCRANTON PENSYLVANIA\",\n\t\t\t\"creditorAddress3\": \"\",\n\t\t\t\"creditorCity\": \"SCRANTON\",\n\t\t\t\"creditorPostalCode\": \"18512\",\n\t\t\t\"creditorCountry\": \"UNITED STATES\",\n\t\t\t\"payToName\": \"HARPERCOLLINS USA\",\n\t\t\t\"postalAddress0\": \"\",\n\t\t\t\"postalAddress1\": \"KEYSTONE INDUSTRIAL PARK\",\n\t\t\t\"postalAddress2\": \"SCRANTON PENSYLVANIA\",\n\t\t\t\"postalAddress3\": \"\",\n\t\t\t\"postalCity\": \"SCRANTON\",\n\t\t\t\"postalPostalCode\": \"18512\",\n\t\t\t\"postalCountry\": \"UNITED STATES\",\n\t\t\t\"telephone\": \"091-212-207-6927\",\n\t\t\t\"fax\": \"\",\n\t\t\t\"emailAddress\": \"accounts@harpercollins.com\",\n\t\t\t\"paymentTerms\": \"14\"\n\t\t},\n\t\t{\n\t\t\t\"sourceId\": \"acumatica\",\n\t\t\t\"creditorNumber\": \"00146\",\n\t\t\t\"creditorName\": \"PENGUIN RANDOM HOUSE UK\",\n\t\t\t\"creditorAddress0\": \"\",\n\t\t\t\"creditorAddress1\": \"20 VAUXHALL BRIDGE ROAD\",\n\t\t\t\"creditorAddress2\": \"LONDON\",\n\t\t\t\"creditorAddress3\": \"\",\n\t\t\t\"creditorCity\": \"LONDON\",\n\t\t\t\"creditorPostalCode\": \"SW1V 2SA\",\n\t\t\t\"creditorCountry\": \"UNITED KINGDOM\",\n\t\t\t\"payToName\": \"PENGUIN RANDOM HOUSE UK\",\n\t\t\t\"postalAddress0\": \"\",\n\t\t\t\"postalAddress1\": \"20 VAUXHALL BRIDGE ROAD\",\n\t\t\t\"postalAddress2\": \"LONDON\",\n\t\t\t\"postalAddress3\": \"\",\n\t\t\t\"postalCity\": \"LONDON\",\n\t\t\t\"postalPostalCode\": \"SW1V 2SA\",\n\t\t\t\"postalCountry\": \"UNITED KINGDOM\",\n\t\t\t\"telephone\": \"+44-20-7840-8400\",\n\t\t\t\"fax\": \"\",\n\t\t\t\"emailAddress\": \"accounts@penguinrandomhouse.co.uk\",\n\t\t\t\"paymentTerms\": \"30\"\n\t\t}\n\t]'\n\n
\n","operationId":"supplierUpdate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APSupplierUpdateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/supplier/create":{"post":{"tags":["Accounting API"],"summary":"Create one or more new accounts payable suppliers.","description":"Create one or more new accounts payable suppliers (creditors). The request body is a JSON array of supplier create requests. The first example is creditor 00145, HarperCollins USA.\n\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/accounting/ap/supplier/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\t-d '[\n\t\t{\n\t\t\t\"sourceId\": \"acumatica\",\n\t\t\t\"creditorNumber\": \"00145\",\n\t\t\t\"creditorName\": \"HARPERCOLLINS USA\",\n\t\t\t\"creditorAddress0\": \"\",\n\t\t\t\"creditorAddress1\": \"KEYSTONE INDUSTRIAL PARK\",\n\t\t\t\"creditorAddress2\": \"SCRANTON PENSYLVANIA\",\n\t\t\t\"creditorAddress3\": \"\",\n\t\t\t\"creditorCity\": \"SCRANTON\",\n\t\t\t\"creditorPostalCode\": \"18512\",\n\t\t\t\"creditorCountry\": \"UNITED STATES\",\n\t\t\t\"payToName\": \"HARPERCOLLINS USA\",\n\t\t\t\"postalAddress0\": \"\",\n\t\t\t\"postalAddress1\": \"KEYSTONE INDUSTRIAL PARK\",\n\t\t\t\"postalAddress2\": \"SCRANTON PENSYLVANIA\",\n\t\t\t\"postalAddress3\": \"\",\n\t\t\t\"postalCity\": \"SCRANTON\",\n\t\t\t\"postalPostalCode\": \"18512\",\n\t\t\t\"postalCountry\": \"UNITED STATES\",\n\t\t\t\"telephone\": \"091-212-207-6927\",\n\t\t\t\"fax\": \"\",\n\t\t\t\"emailAddress\": \"accounts@harpercollins.com\",\n\t\t\t\"taxCategory\": \"OVR\",\n\t\t\t\"taxNumber\": \"\",\n\t\t\t\"currencyExchangeCode\": \"U\",\n\t\t\t\"creditorTypeCode\": \"O\",\n\t\t\t\"paymentTerms\": \"14\"\n\t\t},\n\t\t{\n\t\t\t\"sourceId\": \"acumatica\",\n\t\t\t\"creditorNumber\": \"00146\",\n\t\t\t\"creditorName\": \"PENGUIN RANDOM HOUSE UK\",\n\t\t\t\"creditorAddress0\": \"\",\n\t\t\t\"creditorAddress1\": \"20 VAUXHALL BRIDGE ROAD\",\n\t\t\t\"creditorAddress2\": \"LONDON\",\n\t\t\t\"creditorAddress3\": \"\",\n\t\t\t\"creditorCity\": \"LONDON\",\n\t\t\t\"creditorPostalCode\": \"SW1V 2SA\",\n\t\t\t\"creditorCountry\": \"UNITED KINGDOM\",\n\t\t\t\"payToName\": \"PENGUIN RANDOM HOUSE UK\",\n\t\t\t\"postalAddress0\": \"\",\n\t\t\t\"postalAddress1\": \"20 VAUXHALL BRIDGE ROAD\",\n\t\t\t\"postalAddress2\": \"LONDON\",\n\t\t\t\"postalAddress3\": \"\",\n\t\t\t\"postalCity\": \"LONDON\",\n\t\t\t\"postalPostalCode\": \"SW1V 2SA\",\n\t\t\t\"postalCountry\": \"UNITED KINGDOM\",\n\t\t\t\"telephone\": \"+44-20-7840-8400\",\n\t\t\t\"fax\": \"\",\n\t\t\t\"emailAddress\": \"accounts@penguinrandomhouse.co.uk\",\n\t\t\t\"taxCategory\": \"OVR\",\n\t\t\t\"taxNumber\": \"\",\n\t\t\t\"currencyExchangeCode\": \"P\",\n\t\t\t\"creditorTypeCode\": \"O\",\n\t\t\t\"paymentTerms\": \"30\"\n\t\t}\n\t]'\n\n
\n","operationId":"supplierCreate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/APSupplierCreateRequest"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/invoice/create":{"post":{"tags":["Accounting API"],"summary":"Submit a batch of accounts payable invoices.","description":"Submit a batch of accounts payable invoices.\n eg. from a third-party spend management system. The example below is HarperCollins USA invoice I1259311, an overseas stock purchase of USD 137.43 at an exchange rate of 0.0625, ie. ZAR 2198.88.\n\nExample using curl;\n\ncurl -X POST http://axigrate_host:8181/api/accounting/ap/invoice/create\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\t-d '{\n\t\t\"sourceId\": \"acumatica\",\n\t\t\"invoices\": [\n\t\t\t{\n\t\t\t\t\"creditorNumber\": \"00145\",\n\t\t\t\t\"documentNumber\": \"I1259311\",\n\t\t\t\t\"documentDate\": \"2016-06-01\",\n\t\t\t\t\"taxClassMisc\": \"\",\n\t\t\t\t\"vatRegMisc\": \"\",\n\t\t\t\t\"docType\": \"I\",\n\t\t\t\t\"originalDocumentNumber\": \"I1259311\",\n\t\t\t\t\"paymentDueDate\": \"2016-10-23\",\n\t\t\t\t\"holdFromPayment\": \"N\",\n\t\t\t\t\"documentTotInclVat\": 2198.88,\n\t\t\t\t\"indicatorForDocumentTotInclVat\": \"+\",\n\t\t\t\t\"vatTot\": 0.00,\n\t\t\t\t\"indicatorForVatTot\": \"+\",\n\t\t\t\t\"comment\": \"HARPERCOLLINS USA STOCK PURCHASE\",\n\t\t\t\t\"currencyExchangeCode\": \"U\",\n\t\t\t\t\"nameMiscCreditor\": \"\",\n\t\t\t\t\"addr0MiscCreditor\": \"\",\n\t\t\t\t\"addr1MiscCreditor\": \"\",\n\t\t\t\t\"addr2MiscCreditor\": \"\",\n\t\t\t\t\"addr3MiscCreditor\": \"\",\n\t\t\t\t\"addr4MiscCreditor\": \"\",\n\t\t\t\t\"postcodeMiscCreditor\": \"\",\n\t\t\t\t\"countryMiscCreditor\": \"\",\n\t\t\t\t\"lines\": [\n\t\t\t\t\t{\n\t\t\t\t\t\t\"lineNumber\": 1,\n\t\t\t\t\t\t\"glAccount\": \"013000.50800\",\n\t\t\t\t\t\t\"taxCode\": \"\",\n\t\t\t\t\t\t\"lineTotalInclVat\": 2198.88,\n\t\t\t\t\t\t\"indicatorForLineTotalInclVat\": \"+\",\n\t\t\t\t\t\t\"lineVatTotal\": 0.00,\n\t\t\t\t\t\t\"indicatorForLineVatTotal\": \"+\",\n\t\t\t\t\t\t\"particulars\": \"AP INVOICE I1259311\",\n\t\t\t\t\t\t\"subledger\": \"\",\n\t\t\t\t\t\t\"subledgerKey1\": \"\",\n\t\t\t\t\t\t\"subledgerKey2\": \"\",\n\t\t\t\t\t\t\"subledgerKey3\": \"\",\n\t\t\t\t\t\t\"subledgerKey4\": \"\",\n\t\t\t\t\t\t\"subledgerKey5\": \"\",\n\t\t\t\t\t\t\"texts\": [\n\t\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\t\"text\": \"IMPORT SHIPMENT - 21 CARTONS\"\n\t\t\t\t\t\t\t}\n\t\t\t\t\t\t]\n\t\t\t\t\t}\n\t\t\t\t],\n\t\t\t\t\"total\": {\n\t\t\t\t\t\"recordCount\": 1,\n\t\t\t\t\t\"totalInclVat\": 2198.88,\n\t\t\t\t\t\"indicatorForTotalInclVat\": \"+\",\n\t\t\t\t\t\"vatTotal\": 0.00,\n\t\t\t\t\t\"indicatorForVatTotal\": \"+\"\n\t\t\t\t}\n\t\t\t}\n\t\t]\n\t}'\n\n
\n","operationId":"invoiceCreate","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/APInvoiceCreateRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/jwt/validate":{"get":{"tags":["Authentication API"],"summary":"Check if your token is still valid.","description":"Check if your token is still valid.\n\nExample using curl;\n\ncurl -X GET 'http://axigrate_host:8181/jwt/validate'\n\t-H 'Content-Type: application/json'\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n
","operationId":"validateToken","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"404":{"description":"Error"}}}},"/api/test/something/{serviceClass}":{"get":{"tags":["Test API"],"operationId":"testSomething","parameters":[{"name":"serviceClass","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}}},"/api/test/something":{"get":{"tags":["Test API"],"operationId":"testSomething_1","parameters":[],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object","additionalProperties":{"type":"object"}}}}}}}},"/api/test/process-customer-major-store-codes":{"get":{"tags":["Test API"],"operationId":"processCustomerMajorStoreCodes","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/test/nxtkey/{key}":{"get":{"tags":["Test API"],"summary":"Retrieve a Bookmaster \"next\" key.","description":"Retrieve a Bookmaster \"next\" key.\n\nExample using curl;\ncurl -X GET 'http://axigrate_host:8181/api/test/nxtkey/DS-EDIORD'\n\t-H \"Content-Type: application/json\"\n\n
\n","operationId":"nxtkey","parameters":[{"name":"key","in":"path","description":"The \"next\" key to retrieve","required":true,"schema":{"type":"string"},"example":"DS-EDIORD"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NextKeyRequest"}}}},"404":{"description":"Error"}}}},"/api/test/controldetail/{applicationId}/{key}/{code}":{"get":{"tags":["Test API"],"operationId":"controldetail","parameters":[{"name":"applicationId","in":"path","required":true,"schema":{"type":"string"}},{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"code","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ControlDetail"}}}}}}},"/api/test/cache/users":{"get":{"tags":["Test API"],"operationId":"getCachedUsers","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserImpl"}}}}}}}},"/api/test/":{"get":{"tags":["Test API"],"operationId":"index","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"string"}}}}}}},"/api/sales/order/fetch/{storeCode}":{"get":{"tags":["Sales API"],"summary":"Manually trigger the fetching of sales order(s) from the client.","description":"Manually trigger the fetching of sales order(s) from the client.\n\nExample using curl;\ncurl -X GET 'http://axigrate_host:8181/api/sales/order/fetch/121'\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n\ncurl -X GET 'http://axigrate_host:8181/api/sales/order/fetch/EXC'\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n
\n","operationId":"fetchSalesOrder","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"storeCode","in":"path","description":"The major store code","required":true,"schema":{"type":"string"},"example":121}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/message/fetch/{transactionOrderDateTimeUserExtId}":{"get":{"tags":["Sales API"],"summary":"Fetch and process a TransactionOrderDateTimeUserExt (DSTRO00P extension) message.","description":"Fetch and process a TransactionOrderDateTimeUserExt message.\n\nExample using curl;\ncurl -X GET 'http://axigrate_host:8181/api/sales/message/fetch/12345'\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n
\n","operationId":"fetchTransactionOrderDateTimeUserExtMessage","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"transactionOrderDateTimeUserExtId","in":"path","description":"The TransactionOrderDateTimeUserExt id to fetch and process","required":true,"schema":{"type":"string"},"example":12345}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/message/fetch/batch/{batchId}":{"get":{"tags":["Sales API"],"summary":"Fetch and process a batch of TransactionOrderDateTimeUserExt messages.","description":"Fetch and process a batch of TransactionOrderDateTimeUserExt messages.\n\nExample using curl;\ncurl -X GET 'http://axigrate_host:8181/api/sales/message/fetch/batch/12345'\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n
\n","operationId":"fetchTransactionOrderDateTimeUserExtMessageBatch","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"batchId","in":"path","description":"The batch id to fetch and process a batch of TransactionOrderDateTimeUserExt messages","required":true,"schema":{"type":"string"},"example":12345}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"object"}}}},"404":{"description":"Error"}}}},"/api/sales/item/{itemCode}":{"get":{"tags":["Sales API"],"summary":"Retrieve a sales item\\product\\isbn.","description":"Retrieve a sales item\\product\\isbn. Use this to retrieve an item/check if the item exists.\n\nExample using curl;\ncurl -X GET 'http://axigrate_host:8181/api/sales/item/9781861979988'\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJyb25uaWUiLCJjYXJyaWVyQ29kZSI6IjAxIiwiY29tcGFueUNvZGUiOiIwMSIsImFjY291bnROdW1iZXIiOiIxMjM0NSIsImlhdCI6MTcyOTY1NDUzMSwiZXhwIjoxNzI5NzQwOTMxfQ.roWx7ISI6PHR1zL9t-1qpXvMT0L8rHOcSBGI-fhm2qAJEM_Fy9tBGf3MHfiBUdm_xPP-YGKb3DzULWPJniR1bQ'\n\n
\n","operationId":"itemRetrieve","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"itemCode","in":"path","description":"The item code/product code/isbn","required":true,"schema":{"type":"string"},"example":9781861979988}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Item"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/supplier/retrieve/{creditorNumber}":{"get":{"tags":["Accounting API"],"summary":"Retrieve creditor information.","description":"Retrieve creditor information.\n\n\nExample using curl;\n\ncurl -X GET http://axigrate_host:8181/api/accounting/ap/supplier/retrieve/00145\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\n
\n","operationId":"supplierRetrieve","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"creditorNumber","in":"path","description":"The Bookmaster creditor/supplier number","required":true,"schema":{"type":"string"},"example":"00145"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/APSupplierCreateRequest"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/supplier/exists/{creditorNumber}":{"get":{"tags":["Accounting API"],"summary":"Check if a creditor exists.","description":"Check if a creditor exists.\n\n\nExample using curl;\n\ncurl -X GET http://axigrate_host:8181/api/accounting/ap/supplier/exists/00145\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\n
\n","operationId":"supplierExists","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"creditorNumber","in":"path","description":"The Bookmaster creditor/supplier number","required":true,"schema":{"type":"string"},"example":"00145"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/invoice/retrieve/{creditorNumber}/{documentNumber}":{"get":{"tags":["Accounting API"],"summary":"Retrieve an accounts payable invoice.","description":"Retrieve an accounts payable invoice.\n\n\nExample using curl;\n\ncurl -X GET http://axigrate_host:8181/api/accounting/ap/invoice/retrieve/00145/I1259311\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\n
\n","operationId":"invoiceRetrieve","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"creditorNumber","in":"path","description":"The Bookmaster creditor/supplier number","required":true,"schema":{"type":"string"},"example":"00145"},{"name":"documentNumber","in":"path","description":"The supplier's invoice/document number","required":true,"schema":{"type":"string"},"example":"I1259311"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApTransaction"}}}},"404":{"description":"Error"}}}},"/api/accounting/ap/invoice/exists/{creditorNumber}/{documentNumber}":{"get":{"tags":["Accounting API"],"summary":"Check if an accounts payable invoice exists.","description":"Check if an accounts payable invoice exists.\n\n\nExample using curl;\n\ncurl -X GET http://axigrate_host:8181/api/accounting/ap/invoice/exists/00145/I1259311\n\t-H \"Content-Type: application/json\"\n\t-H 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9...'\n\n
\n","operationId":"invoiceExists","parameters":[{"name":"Authorization","in":"header","required":true,"schema":{"type":"string"}},{"name":"creditorNumber","in":"path","description":"The Bookmaster creditor/supplier number","required":true,"schema":{"type":"string"},"example":"00145"},{"name":"documentNumber","in":"path","description":"The supplier's invoice/document number","required":true,"schema":{"type":"string"},"example":"I1259311"}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"404":{"description":"Error"}}}}},"components":{"schemas":{"AuthRequest":{"type":"object","properties":{"username":{"type":"string","description":"This is your user name, this will be issued to you by the customer.","example":"your_axigrate_username"},"password":{"type":"string","description":"This is your password, this will be issued to you by the customer.","example":"your_axigrate_password"}},"description":"User AuthRequest for authentication and receiving a token."},"EmailRequest":{"type":"object","properties":{"to":{"type":"string","description":"The 'to' recipient of the email.","example":"someone@axiom.co.za"},"cc":{"type":"string","description":"The 'cc' recipient of the email."},"bcc":{"type":"string","description":"The 'bcc' recipient of the email."},"subject":{"type":"string","description":"The subject line of the email.","example":"Axigrate test email"},"text":{"type":"string","description":"The plain text body of the email.","example":"This is a test email sent from Axigrate."}},"description":"EmailRequest, send a plain text test email through the configured mail server."},"AnExampleGenericMessageString":{"type":"object","properties":{"payload":{"type":"string"}}},"GrantedAuthority":{"type":"object","properties":{"authority":{"type":"string"}}},"UserImpl":{"type":"object","properties":{"password":{"type":"string"},"username":{"type":"string"},"authorities":{"type":"array","items":{"$ref":"#/components/schemas/GrantedAuthority"}},"accountNonExpired":{"type":"boolean"},"accountNonLocked":{"type":"boolean"},"credentialsNonExpired":{"type":"boolean"},"enabled":{"type":"boolean"},"as400Username":{"type":"string"},"as400Password":{"type":"string"},"sourceId":{"type":"string"},"defaultCompanyCode":{"type":"string"},"defaultAccountNumber":{"type":"string"},"defaultWarehouseLocation":{"type":"string"},"defaultWarehouseNumber":{"type":"string"},"defaultCarrierCode":{"type":"string"},"defaultHomeDirectory":{"type":"string"},"prefixHomeDirectory":{"type":"string"},"authoritiesAsString":{"type":"string"},"absoluteHomeDirectory":{"type":"string"}}},"SalesOrderLineTextUpdateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"text":{"type":"string","description":"The text. One object per line of text.","example":"QUANTITY INCREASED ON CUSTOMER REQUEST"},"orderTextLineNumber":{"type":"number","description":"The sequence of this text line within the text block, starting at 1.","example":1},"textType":{"type":"string","description":"The text type, which controls where the text is printed, eg. 'DTL' (despatch note). Must exist in the Bookmaster text type controls.","example":"DTL"}},"description":"SalesOrderLineTextUpdateRequest, replace a line of free format text attached to an existing sales order line."},"SalesOrderLineUpdateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"itemCode":{"type":"string","description":"The item code/product code/isbn on the line being updated. This must match the item on the existing order line.","example":"9781861974044"},"orderLineNumber":{"type":"number","description":"The line number of the line being updated, as supplied when the order was created.","example":20},"orderQuantity":{"type":"number","description":"The new quantity for this line. This replaces the quantity originally ordered.","example":4},"salesOrderLineTextUpdateRequests":{"type":"array","description":"Free format text attached to this order line. Supplying this replaces the text held against the line.","items":{"$ref":"#/components/schemas/SalesOrderLineTextUpdateRequest"}}},"description":"SalesOrderLineUpdateRequest, a single line of an existing sales order that is being updated. The line is matched on orderLineNumber and itemCode."},"SalesOrderUpdateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"accountNumber":{"type":"string","description":"Your Bookmaster customer/debtor account number. This will be issued to you by the customer. If left blank, the account number attached to your token is used.","example":"0000510788"},"carrierCode":{"type":"string","description":"The carrier/courier the order must be despatched with, eg. '**' to use the carrier held against the customer account. Must exist in the Bookmaster carrier controls.","example":"**"},"customerReference":{"type":"string","description":"Your own order reference/purchase order number. This identifies the order to be updated and must match the reference used when the order was created.","example":"16847"},"deliveryAddress1":{"type":"string","description":"The first line of the delivery address.","example":"EXCLUSIVE BOOKS GROUP(PTY)LTD"},"deliveryAddress2":{"type":"string","description":"The second line of the delivery address.","example":"SHOP 2127 MALL OF AFRICA"},"deliveryAddress3":{"type":"string","description":"The third line of the delivery address.","example":"MAGWA CRESCENT"},"deliveryAddress4":{"type":"string","description":"The suburb/city of the delivery address.","example":"WATERFALL CITY"},"deliveryAddress5":{"type":"string","description":"The postal code of the delivery address.","example":"1682"},"deliveryAddress6":{"type":"string","description":"The country of the delivery address.","example":"SOUTH AFRICA"},"deliveryName":{"type":"string","description":"The name the delivery is made out to.","example":"EXCLUSIVE BOOKS MALL OF AFRICA"},"standardAccountNumber":{"type":"string","description":"The Standard Account Number (SAN)/GLN of the delivery point. This will be issued to you by the customer.","example":"5030670179893"},"partialDelivery":{"type":"string","description":"'Y' to accept a partial delivery where not all lines can be supplied in full, 'N' to hold the order until it can be supplied in full.","example":"Y"},"phoneNumber":{"type":"string","description":"The delivery contact telephone number.","example":"011 798 0000"},"faxNumber":{"type":"string","description":"The delivery contact fax number.","example":"011 803 0002"},"salesOrderLineUpdateRequests":{"type":"array","description":"The order lines being updated. Supply only the lines that are changing.","items":{"$ref":"#/components/schemas/SalesOrderLineUpdateRequest"}}},"description":"SalesOrderUpdateRequest, update an existing sales order in Bookmaster. The order is identified by your customerReference. Only supply the lines you are changing. The examples below are taken from Exclusive Books order EB-16847."},"SalesOrderReturnCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"accountNumber":{"type":"string","description":"Your Bookmaster customer/debtor account number. This will be issued to you by the customer. If left blank, the account number attached to your token is used.","example":"0000510788"},"customerReference":{"type":"string","description":"Your own reference for this return. Where the return relates to an order previously placed, use that order's reference.","example":"16847"},"replyTo":{"type":"string","description":"Optional. An email address to send the return authorisation (the claim number Bookmaster allocates) to, once the return has been created. Only emailed where the installation has sales.order.return.send.email=true.","example":"returns@exclusivebooks.co.za"},"salesOrderReturnLineCreateRequests":{"type":"array","description":"The lines being returned. At least one line is required.","items":{"$ref":"#/components/schemas/SalesOrderReturnLineCreateRequest"}},"claimNumber":{"type":"string","description":"The claim number. Always '*NEW', set by Axigrate - any value sent is ignored. Bookmaster allocates the claim number.","readOnly":true,"example":"*NEW"},"claimDate":{"type":"string","description":"The date the claim/return is raised. Always the date it is received, set by Axigrate - any value sent is ignored.","format":"date-time","readOnly":true}},"description":"SalesOrderReturnCreateRequest, raise a claim/return against goods previously supplied. The examples below are taken from Exclusive Books order EB-16847."},"SalesOrderReturnLineCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"lineNumber":{"type":"number","description":"The line number of this line within the claim/return.","example":30},"itemCode":{"type":"string","description":"The item code/product code/isbn being returned. The item must exist in Bookmaster.","example":"9780008507237"},"quantity":{"type":"number","description":"The quantity being returned. This may not exceed the quantity originally supplied.","example":1},"reasonCode":{"type":"string","description":"The reason the goods are being returned, eg. '01'. One or two characters, must exist in the Bookmaster controls (TMSDS/TR-RSN).","example":"01"}},"description":"SalesOrderReturnLineCreateRequest, a single line of a claim/return."},"SalesOrderBillingCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"billingAddress1":{"type":"string","description":"The first line of the billing address.","example":"PO BOX 605"},"billingAddress2":{"type":"string","description":"The second line of the billing address."},"billingAddress3":{"type":"string","description":"The third line of the billing address."},"billingAddress4":{"type":"string","description":"The suburb/city of the billing address.","example":"RIVONIA"},"billingAddress5":{"type":"string","description":"The postal code of the billing address.","example":"2128"},"billingAddress6":{"type":"string","description":"The country of the billing address.","example":"SOUTH AFRICA"},"billingCustomerName":{"type":"string","description":"The name the invoice is made out to.","example":"EXCLUSIVE BOOKS GROUP(PTY)LTD"},"billingFaxNumber":{"type":"string","description":"The billing contact fax number.","example":"011 803 0002"},"billingPhoneNumber":{"type":"string","description":"The billing contact telephone number.","example":"011 798 0000"}},"description":"SalesOrderBillingCreateRequest, the billing/invoice-to details of a sales order. Supply this only where the billing details differ from those held against the customer account in Bookmaster."},"SalesOrderCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"accountNumber":{"type":"string","description":"Your Bookmaster customer/debtor account number. This will be issued to you by the customer. If left blank, the account number attached to your token is used.","example":"0000510788"},"carrierCode":{"type":"string","description":"The carrier/courier the order must be despatched with, eg. '**' to use the carrier held against the customer account. Must exist in the Bookmaster carrier controls.","example":"**"},"customerReference":{"type":"string","description":"Your own order reference/purchase order number. This is carried through onto the Bookmaster order, the despatch note and the invoice, and is used to acknowledge the order back to you.","example":"16847"},"customerReferenceDate":{"type":"string","description":"eg. 2026-07-22, the date of your order reference/purchase order.","format":"date-time"},"deliveryAddress1":{"type":"string","description":"The first line of the delivery address.","example":"EXCLUSIVE BOOKS GROUP(PTY)LTD"},"deliveryAddress2":{"type":"string","description":"The second line of the delivery address.","example":"SHOP 2127 MALL OF AFRICA"},"deliveryAddress3":{"type":"string","description":"The third line of the delivery address.","example":"MAGWA CRESCENT"},"deliveryAddress4":{"type":"string","description":"The suburb/city of the delivery address.","example":"WATERFALL CITY"},"deliveryAddress5":{"type":"string","description":"The postal code of the delivery address.","example":"1682"},"deliveryAddress6":{"type":"string","description":"The country of the delivery address.","example":"SOUTH AFRICA"},"deliveryName":{"type":"string","description":"The name the delivery is made out to.","example":"EXCLUSIVE BOOKS MALL OF AFRICA"},"deliveryNumber":{"type":"number","description":"The pre-defined delivery number for the account, one account can have multiple delivery numbers. This will be issued to you by the customer."},"standardAccountNumber":{"type":"string","description":"The Standard Account Number (SAN)/GLN of the delivery point. This will be issued to you by the customer.","example":"5030670179893"},"emailAddress":{"type":"string","description":"The email address order confirmations and documents for this order are sent to.","example":"MALLOFAFRICA.RETURNS@EXCLUSIVEBOOKS.CO.ZA"},"specialInstructions1":{"type":"string","description":"The first line of special delivery instructions. This is printed on the despatch note.","example":"DELIVER TO RECEIVING - SHOP 2127"},"specialInstructions2":{"type":"string","description":"The second line of special delivery instructions. This is printed on the despatch note.","example":"CALL STORE ON ARRIVAL"},"sourceOfOrder":{"type":"string","description":"This identifies where the order originated, eg. 'EB' (Exclusive Books). This will be issued to you by the customer.","example":"EB"},"partialDelivery":{"type":"string","description":"'Y' to accept a partial delivery where not all lines can be supplied in full, 'N' to hold the order until it can be supplied in full.","example":"Y"},"salesOrderLineTextCreateRequests":{"type":"array","description":"Free format text attached to the order header, eg. delivery notes. This is printed on the despatch note.","items":{"$ref":"#/components/schemas/SalesOrderLineTextCreateRequest"}},"salesOrderBillingCreateRequest":{"$ref":"#/components/schemas/SalesOrderBillingCreateRequest"},"salesOrderLineCreateRequests":{"type":"array","description":"The order lines. At least one line is required.","items":{"$ref":"#/components/schemas/SalesOrderLineCreateRequest"}}},"description":"SalesOrderCreateRequest, create a new sales order in Bookmaster. The examples below are taken from Exclusive Books order EB-16847."},"SalesOrderLineCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"despatchDate":{"type":"string","description":"eg. 2026-07-23, the date this line is required to be despatched.","format":"date-time"},"itemCode":{"type":"string","description":"The item code/product code/isbn being ordered. The item must exist in Bookmaster.","example":"9781861979988"},"orderLineNumber":{"type":"number","description":"The line number of this line within the order. Number the lines in tens (10, 20, 30, ...) to leave room for later insertions.","example":10},"netPriceFlag":{"type":"string","description":"'Y' if the unitPrice supplied is a net price and must be used as-is, 'N' to let Bookmaster price the line off the customer's price file.","example":"Y"},"orderQuantity":{"type":"number","description":"The quantity ordered for this line.","example":1},"unitPrice":{"type":"number","description":"The unit price for this line, excluding tax. Only used when netPriceFlag is 'Y'.","example":195.0},"itemDescription":{"type":"string","description":"The item description/title as you know it. Informational only, Bookmaster prints its own description.","example":"CONCISE 33 STRATEGIES OF WAR PB"},"itemBarcode":{"type":"string","description":"The barcode of the item being ordered. This is usually the same as the item code/isbn.","example":"9781861979988"},"salesOrderLineTextCreateRequests":{"type":"array","description":"Free format text attached to this order line. This is printed on the despatch note.","items":{"$ref":"#/components/schemas/SalesOrderLineTextCreateRequest"}}},"description":"SalesOrderLineCreateRequest, a single line of a new sales order."},"SalesOrderLineTextCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"text":{"type":"string","description":"The text. One object per line of text.","example":"GIFT WRAP THIS TITLE"},"orderTextLineNumber":{"type":"number","description":"The sequence of this text line within the text block, starting at 1.","example":1},"textType":{"type":"string","description":"The text type, which controls where the text is printed, eg. 'DTL' (despatch note). Must exist in the Bookmaster text type controls.","example":"DTL"}},"description":"SalesOrderLineTextCreateRequest, a line of free format text attached to a sales order header or order line."},"SalesOrderCancelRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"accountNumber":{"type":"string","description":"Your Bookmaster customer/debtor account number. This will be issued to you by the customer. If left blank, the account number attached to your token is used.","example":"0000510788"},"customerReference":{"type":"string","description":"Your own order reference/purchase order number. This identifies the order to be cancelled and must match the reference used when the order was created.","example":"16847"},"reason":{"type":"string","description":"The reason the order or the lines are being cancelled. This is recorded against the Bookmaster order.","example":"CUSTOMER CANCELLED - TITLES NO LONGER REQUIRED"},"salesOrderLineCancelRequests":{"type":"array","description":"The order lines to cancel. Omit this to cancel the whole order.","items":{"$ref":"#/components/schemas/SalesOrderLineCancelRequest"}}},"description":"SalesOrderCancelRequest, cancel an existing sales order in Bookmaster. The order is identified by your customerReference. Supply salesOrderLineCancelRequests to cancel individual lines, or omit it to cancel the whole order. The examples below are taken from Exclusive Books order EB-16847."},"SalesOrderLineCancelRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"itemCode":{"type":"string","description":"The item code/product code/isbn on the line being cancelled. This must match the item on the existing order line.","example":"9780349439273"},"orderLineNumber":{"type":"number","description":"The line number of the line being cancelled, as supplied when the order was created.","example":60}},"description":"SalesOrderLineCancelRequest, a single line of an existing sales order that is being cancelled. The line is matched on orderLineNumber and itemCode."},"ItemChangeRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"itemCode":{"type":"string","description":"The item code/product code/isbn of the item to update. The item must already exist in Bookmaster.","example":"9781861974044"},"itemDescription":{"type":"string","description":"The new item description/title.","example":"CONCISE 48 LAWS OF POWER PB"},"itemBarcode":{"type":"string","description":"The new barcode for the item. This is usually the same as the item code/isbn.","example":"9781861974044"}},"description":"ItemChangeRequest, update an existing sales item/product/isbn in Bookmaster."},"ProductCatalogSendRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"identifier":{"type":"string","description":"This identifies the predefined catalogue list to build and send. The identifiers are configured in Bookmaster and will be issued to you by the customer.","example":"AH6SO"},"storeCode":{"type":"string","description":"The store the catalogue is sent to, eg. 'AMZ' (Amazon). This will be issued to you by the customer.","example":"AMZ"}},"description":"ProductCatalogSendRequest, manually trigger the build and send of a predefined product catalogue to a store."},"ItemClassificationCreateRequest":{"type":"object","properties":{"type":{"type":"string","description":"The item classification type. Must exist in the Bookmaster controls TMSDS/IC-TYPES.","example":"IC-WEBD"},"code":{"type":"string","description":"The item classification code for the type. Must exist in the Bookmaster controls TMSDS/{type}.","example":"Y"}},"description":"ItemClassificationCreateRequest, an item classification to attach to the new item, eg. the web display flag IC-WEBD."},"ItemCreateRequest":{"type":"object","properties":{"uploadId":{"type":"string"},"itemCode":{"type":"string","description":"The item code/product code/isbn. This is the key of the item in Bookmaster and must be unique.","example":"9781861979988"},"itemDescription":{"type":"string","description":"The item description/title.","example":"CONCISE 33 STRATEGIES OF WAR PB"},"stockReport":{"type":"string","description":"The stock report code of the item."},"unitOfMeasure":{"type":"string","description":"The unit of measure the item is sold in. Leave blank for the default (each)."},"itemBarcode":{"type":"string","description":"The barcode for the item. This is usually the same as the item code/isbn.","example":"9781861979988"},"supplierItemCode":{"type":"string","description":"The supplier's own code for this item, where it differs from the item code."},"itemLongDescription":{"type":"string","description":"The long description of the item. Stored as text type IDL, split into lines of 72 characters."},"brandCode":{"type":"string","description":"The brand code/imprint of the item.","example":"PEN"},"itemDiscountClass":{"type":"string","description":"The item discount class."},"abcClass":{"type":"string","description":"The ABC class of the item.","example":"A"},"stockItem":{"type":"string","description":"'Y' if the item is a stock item, 'N' if not.","example":"Y"},"binding":{"type":"string","description":"The binding of the item.","example":"PB"},"buyingPrice":{"type":"number","description":"The buying price of the item, in the currency of currencyCode.","example":12.99},"supplierDiscount":{"type":"number","description":"The supplier discount percentage.","example":52.5},"weight":{"type":"number","description":"The net weight of the item, in kilograms.","example":0.25},"rrp":{"type":"number","description":"The recommended retail price of the item.","example":350.0},"stockStatus":{"type":"string","description":"The stock status of the item."},"releaseDate":{"type":"string","description":"eg. 2026-08-01, the local release date of the item.","format":"date-time"},"firmSale":{"type":"string","description":"'Y' if the item is firm sale (not returnable), 'N' if not.","example":"N"},"linkItemCode":{"type":"string","description":"The item code of an existing item this item is linked to."},"catalogueId":{"type":"string","description":"The catalogue/menu to place the item in. Must be an existing catalogue.","example":"F#RANGENERAL FICTION"},"itemClassifications":{"type":"array","description":"The item classifications to attach to the item.","items":{"$ref":"#/components/schemas/ItemClassificationCreateRequest"}},"author":{"type":"string","description":"The author of the item.","example":"GREENE, ROBERT"},"categoryL1":{"type":"string","description":"Item classification level 1, the item class. Must exist in the Bookmaster item classification controls.","example":"040"},"categoryL2":{"type":"string","description":"Item classification level 2, the item division. Must exist in the Bookmaster item classification controls.","example":"K91"},"categoryL3":{"type":"string","description":"Item classification level 3, the item group. Must exist in the Bookmaster item classification controls.","example":"990"},"categoryL4":{"type":"string","description":"Item classification level 4, the item category. Must exist in the Bookmaster item classification controls.","example":"700"},"categoryL5":{"type":"string","description":"Item classification level 5, the item subcategory. Must exist in the Bookmaster item classification controls.","example":"752"},"currencyCode":{"type":"string","description":"The ex-factory/buying currency of the item, eg. 'R' (Rand), 'U' (US Dollar), 'P' (Pound). Must exist in the Bookmaster currency controls.","example":"R"},"alternateItemCode":{"type":"string","description":"An alternate item code for the item, eg. the 10 digit isbn where the item code is the 13 digit isbn.","example":"1861979983"},"packItem":{"type":"string","description":"Packitem code, a pack/kit made up of component items, valid values (B|N|P|S).","example":"N"},"packagingType":{"type":"string","description":"The packaging type of the item."},"overseasReleaseDate":{"type":"string","description":"eg. 2026-07-01, the overseas release date of the item.","format":"date-time"},"overseasPrice":{"type":"number","description":"The overseas price of the item.","example":12.99}},"description":"ItemCreateRequest, create a new sales item/product/isbn in Bookmaster."},"AResponse":{"type":"object","properties":{"valid":{"type":"boolean"},"messageId":{"type":"string"},"message":{"type":"string"},"detailMessages":{"type":"object","additionalProperties":{"type":"string"}}}},"GLJournalCreateRequest":{"type":"object","properties":{"sourceId":{"type":"string","description":"This identifies the system sending the batch, eg. 'vip' (payroll), 'acumatica'. This will be issued to you by the customer and is used to trace the batch back to its source.","example":"vip"},"uploadId":{"type":"string"},"journalEntries":{"type":"array","description":"The journal entry lines in this batch. All lines of one journal share the same glCompany, journalType and journalNumber, and are numbered by lineNumber. The amounts must sum to zero.","items":{"$ref":"#/components/schemas/GlStandingJournal"}}},"description":"GLJournalCreateRequest, submit a batch of general ledger journal entries into Bookmaster. The entries in a batch must balance, ie. the amounts must sum to zero."},"GlStandingJournal":{"type":"object","properties":{"profitCentre":{"type":"string","description":"The profit centre/cost centre the amount is posted to. Must exist in the Bookmaster general ledger.","example":"005001"},"glAccountMajor":{"type":"string","description":"The major segment of the general ledger account the amount is posted to. Must exist in the Bookmaster general ledger.","example":"38911"},"glAccountMinor":{"type":"string","description":"The minor/sub segment of the general ledger account the amount is posted to. Leave blank where the account is not sub-analysed."},"amount":{"type":"number","description":"The amount posted to this account, in the base currency. Positive for a debit, negative for a credit. The amounts of all lines of a journal must sum to zero.","example":4234.81},"currencyExchangeCode":{"type":"string","description":"The currency of the entry, eg. 'R' (Rand), 'U' (US Dollar), 'P' (Pound). Must exist in the Bookmaster currency controls.","example":"R"},"foreignAmount":{"type":"number","description":"The amount posted to this account, in the currency given by currencyExchangeCode. Equal to amount where the entry is in the base currency.","example":4234.81},"journalEntryId":{"$ref":"#/components/schemas/GlStandingJournalPK"},"journalEntryDescription":{"type":"string","description":"The narration/particulars of this journal entry line, as it appears on the general ledger. Maximum 20 characters.","example":"PROV DDC CHARGE JUN'"}},"description":"GlStandingJournal, a single general ledger journal entry line. All lines of one journal share the same journalEntryId glCompany, journalType and journalNumber, and are numbered by lineNumber. The amounts of a journal must sum to zero."},"GlStandingJournalPK":{"type":"object","properties":{"glCompany":{"type":"string","description":"The general ledger company the journal is posted to. Must exist in the Bookmaster general ledger.","example":"01"},"journalType":{"type":"string","description":"The journal type, eg. 'G' (general), 'P' (payroll). One character, must exist in the Bookmaster journal type controls.","example":"G"},"journalNumber":{"type":"string","description":"The journal number. All lines of one journal share the same journal number. Maximum 8 characters.","example":"GA000259"},"lineNumber":{"type":"number","description":"The line number of this entry within the journal, starting at 1.","example":1}},"description":"GlStandingJournalPK, the composite key identifying a general ledger journal entry line."},"APSupplierUpdateRequest":{"type":"object","properties":{"sourceId":{"type":"string","description":"This identifies the system sending the supplier, eg. 'acumatica', 'fraxion'. This will be issued to you by the customer and is used to trace the supplier back to its source.","example":"acumatica"},"uploadId":{"type":"string"},"creditorName":{"type":"string","description":"The registered name of the supplier/creditor.","example":"HARPERCOLLINS USA"},"creditorAddress0":{"type":"string","description":"The first line of the supplier's physical/trading address."},"creditorAddress1":{"type":"string","description":"The second line of the supplier's physical/trading address.","example":"KEYSTONE INDUSTRIAL PARK"},"creditorAddress2":{"type":"string","description":"The third line of the supplier's physical/trading address.","example":"SCRANTON PENSYLVANIA"},"creditorAddress3":{"type":"string","description":"The fourth line of the supplier's physical/trading address."},"payToName":{"type":"string","description":"The name the remittance/payment is made out to, where this differs from the creditor name.","example":"HARPERCOLLINS USA"},"postalAddress0":{"type":"string","description":"The first line of the supplier's postal/remittance address."},"postalAddress1":{"type":"string","description":"The second line of the supplier's postal/remittance address.","example":"KEYSTONE INDUSTRIAL PARK"},"postalAddress2":{"type":"string","description":"The third line of the supplier's postal/remittance address.","example":"SCRANTON PENSYLVANIA"},"postalAddress3":{"type":"string","description":"The fourth line of the supplier's postal/remittance address."},"telephone":{"type":"string","description":"The supplier's contact telephone number.","example":"091-212-207-6927"},"fax":{"type":"string","description":"The supplier's fax number."},"emailAddress":{"type":"string","description":"The supplier's accounts/remittance email address.","example":"accounts@harpercollins.com"},"paymentTerms":{"type":"string","description":"The payment terms code for this supplier, eg. '14' (14 days). Must exist in the Bookmaster payment terms controls.","example":"14"},"creditorNumber":{"type":"string","description":"The Bookmaster creditor/supplier number.","example":"00145"},"creditorCity":{"type":"string","description":"The city/town of the supplier's physical/trading address.","example":"SCRANTON"},"creditorPostalCode":{"type":"string","description":"The postal/zip code of the supplier's physical/trading address.","example":"18512"},"creditorCountry":{"type":"string","description":"The country of the supplier's physical/trading address.","example":"UNITED STATES"},"postalCity":{"type":"string","description":"The city/town of the supplier's postal/remittance address.","example":"SCRANTON"},"postalPostalCode":{"type":"string","description":"The postal/zip code of the supplier's postal/remittance address.","example":"18512"},"postalCountry":{"type":"string","description":"The country of the supplier's postal/remittance address.","example":"UNITED STATES"}},"description":"APSupplierCreateRequest, Update an accounts payable supplier (creditor) in Bookmaster."},"APSupplierCreateRequest":{"type":"object","properties":{"sourceId":{"type":"string","description":"This identifies the system sending the supplier, eg. 'acumatica', 'fraxion'. This will be issued to you by the customer and is used to trace the supplier back to its source.","example":"acumatica"},"uploadId":{"type":"string"},"creditorName":{"type":"string","description":"The registered name of the supplier/creditor.","example":"HARPERCOLLINS USA"},"creditorAddress0":{"type":"string","description":"The first line of the supplier's physical/trading address."},"creditorAddress1":{"type":"string","description":"The second line of the supplier's physical/trading address.","example":"KEYSTONE INDUSTRIAL PARK"},"creditorAddress2":{"type":"string","description":"The third line of the supplier's physical/trading address.","example":"SCRANTON PENSYLVANIA"},"creditorAddress3":{"type":"string","description":"The fourth line of the supplier's physical/trading address."},"payToName":{"type":"string","description":"The name the remittance/payment is made out to, where this differs from the creditor name.","example":"HARPERCOLLINS USA"},"postalAddress0":{"type":"string","description":"The first line of the supplier's postal/remittance address."},"postalAddress1":{"type":"string","description":"The second line of the supplier's postal/remittance address.","example":"KEYSTONE INDUSTRIAL PARK"},"postalAddress2":{"type":"string","description":"The third line of the supplier's postal/remittance address.","example":"SCRANTON PENSYLVANIA"},"postalAddress3":{"type":"string","description":"The fourth line of the supplier's postal/remittance address."},"telephone":{"type":"string","description":"The supplier's contact telephone number.","example":"091-212-207-6927"},"fax":{"type":"string","description":"The supplier's fax number."},"emailAddress":{"type":"string","description":"The supplier's accounts/remittance email address.","example":"accounts@harpercollins.com"},"taxCategory":{"type":"string","description":"The tax/VAT category of the supplier, eg. 'OVR' (overseas). Must exist in the Bookmaster tax category controls.","example":"OVR"},"currencyExchangeCode":{"type":"string","description":"The currency the supplier is traded in, eg. 'R' (Rand), 'U' (US Dollar), 'P' (Pound). Must exist in the Bookmaster currency controls.","example":"U"},"paymentTerms":{"type":"string","description":"The payment terms code for this supplier, eg. '14' (14 days). Must exist in the Bookmaster payment terms controls.","example":"14"},"creditorNumber":{"type":"string","description":"The Bookmaster creditor/supplier number.","example":"00145"},"creditorCity":{"type":"string","description":"The city/town of the supplier's physical/trading address.","example":"SCRANTON"},"creditorPostalCode":{"type":"string","description":"The postal/zip code of the supplier's physical/trading address.","example":"18512"},"creditorCountry":{"type":"string","description":"The country of the supplier's physical/trading address.","example":"UNITED STATES"},"postalCity":{"type":"string","description":"The city/town of the supplier's postal/remittance address.","example":"SCRANTON"},"postalPostalCode":{"type":"string","description":"The postal/zip code of the supplier's postal/remittance address.","example":"18512"},"postalCountry":{"type":"string","description":"The country of the supplier's postal/remittance address.","example":"UNITED STATES"},"taxNumber":{"type":"string","description":"The supplier's tax/VAT registration number. Blank for overseas suppliers that are not VAT registered locally."},"creditorTypeCode":{"type":"string","description":"The accounts payable creditor type, eg. 'O' (overseas), 'L' (local). Must exist in the Bookmaster creditor type controls.","example":"O"}},"description":"APSupplierCreateRequest, create a new accounts payable supplier (creditor) in Bookmaster."},"APInvoiceCreateRequest":{"type":"object","properties":{"sourceId":{"type":"string","description":"This identifies the source system sending the batch/invoice, eg. 'acumatica', 'fraxion'. This will be issued to you by the customer and is used to trace the batch/invoice back to its source.","example":"acumatica"},"uploadId":{"type":"string"},"invoices":{"type":"array","description":"The invoices in this batch. Each invoice carries its own lines, texts and totals.","items":{"$ref":"#/components/schemas/InvoiceHeader"}}},"description":"APInvoiceCreateRequest, submit a batch of accounts payable (creditor) invoices into Bookmaster."},"InvoiceDetail":{"type":"object","properties":{"lineNumber":{"type":"number","description":"The line number of this line within the invoice, starting at 1.","example":1},"glAccount":{"type":"string","description":"The general ledger account the line amount is expensed to. Must exist in the Bookmaster general ledger.","example":"013000.50800"},"taxCode":{"type":"string","description":"The tax/VAT code applied to this line. Leave blank where no local VAT applies, eg. an overseas supplier."},"lineTotalInclVat":{"type":"number","description":"The line total including tax/VAT, as an unsigned amount. The sign is given by indicatorForLineTotalInclVat.","example":2198.88},"indicatorForLineTotalInclVat":{"type":"string","description":"The sign of lineTotalInclVat, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"lineVatTotal":{"type":"number","description":"The tax/VAT portion of the line total, as an unsigned amount.","example":0.0},"indicatorForLineVatTotal":{"type":"string","description":"The sign of lineVatTotal, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"particulars":{"type":"string","description":"The narration/particulars of this line, as it appears on the general ledger. Maximum 20 characters.","example":"AP INVOICE I1259311"},"subledger":{"type":"string","description":"The subledger the line is analysed to, where the general ledger account is subledger controlled. Leave blank otherwise."},"subledgerKey1":{"type":"string","description":"The first subledger analysis key. Only used where subledger is supplied."},"subledgerKey2":{"type":"string","description":"The second subledger analysis key. Only used where subledger is supplied."},"subledgerKey3":{"type":"string","description":"The third subledger analysis key. Only used where subledger is supplied."},"subledgerKey4":{"type":"string","description":"The fourth subledger analysis key. Only used where subledger is supplied."},"subledgerKey5":{"type":"string","description":"The fifth subledger analysis key. Only used where subledger is supplied."},"texts":{"type":"array","description":"Free format text attached to this invoice line.","items":{"$ref":"#/components/schemas/InvoiceText"}}},"description":"InvoiceDetail, a single line of an accounts payable (creditor) invoice, giving the general ledger account the amount is expensed to."},"InvoiceHeader":{"type":"object","properties":{"creditorNumber":{"type":"string","description":"The Bookmaster creditor/supplier number the invoice is raised against. The creditor must already exist in Bookmaster.","example":"00145"},"documentNumber":{"type":"string","description":"The supplier's invoice number. Together with creditorNumber this uniquely identifies the invoice in Bookmaster.","example":"I1259311"},"documentDate":{"type":"string","description":"eg. 2016-06-01, the date on the supplier's invoice.","format":"date","example":"2016-06-01"},"taxClassMisc":{"type":"string","description":"The tax/VAT class, used only for a miscellaneous (one-off) creditor. Leave blank for an existing creditor."},"vatRegMisc":{"type":"string","description":"The tax/VAT registration number, used only for a miscellaneous (one-off) creditor. Leave blank for an existing creditor."},"docType":{"type":"string","description":"The document type, eg. 'I' (invoice), 'C' (credit note). One character.","example":"I"},"originalDocumentNumber":{"type":"string","description":"The number of the document this one relates to, eg. the invoice a credit note is raised against. Leave blank for a plain invoice.","example":"I1259311"},"dueDateCode":{"type":"string","description":"The due date code, eg. '01' (?), '02' (?). Two characters.","example":"01"},"paymentDueDate":{"type":"string","description":"eg. 2016-10-23, the date the invoice falls due for payment.","format":"date","example":"2016-10-23"},"holdFromPayment":{"type":"string","description":"'Y' to load the invoice on hold so it is not paid until released, otherwise 'N'.","example":"N"},"documentTotInclVat":{"type":"number","description":"The invoice total including tax/VAT, as an unsigned amount. The sign is given by indicatorForDocumentTotInclVat.","example":2198.88},"indicatorForDocumentTotInclVat":{"type":"string","description":"The sign of documentTotInclVat, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"vatTot":{"type":"number","description":"The tax/VAT portion of the invoice total, as an unsigned amount. Zero for an overseas supplier that does not charge local VAT.","example":0.0},"indicatorForVatTot":{"type":"string","description":"The sign of vatTot, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"discountTot":{"type":"number","description":"The discount total, as an unsigned amount.","example":0.0},"indicatorForDiscountTot":{"type":"string","description":"The sign of discount total, '+' for a debit (credit) or '-' for a invoice.","example":"+"},"comment":{"type":"string","description":"A free format comment recorded against the invoice. Maximum 50 characters.","example":"HARPERCOLLINS USA STOCK PURCHASE"},"nameMiscCreditor":{"type":"string","description":"The creditor name, used only for a miscellaneous (one-off) creditor. Leave blank for an existing creditor.","example":"HARPERCOLLINNS US"},"addr0MiscCreditor":{"type":"string","description":"The first line of the address, used only for a miscellaneous (one-off) creditor."},"addr1MiscCreditor":{"type":"string","description":"The second line of the address, used only for a miscellaneous (one-off) creditor.","example":"KEYSTONE INDUSTRIAL PARK"},"addr2MiscCreditor":{"type":"string","description":"The third line of the address, used only for a miscellaneous (one-off) creditor.","example":"SCRANTON PENSYLVANIA"},"addr3MiscCreditor":{"type":"string","description":"The fourth line of the address, used only for a miscellaneous (one-off) creditor."},"addr4MiscCreditor":{"type":"string","description":"The city/town of the address, used only for a miscellaneous (one-off) creditor.","example":"SCRANTON"},"postcodeMiscCreditor":{"type":"string","description":"The postal/zip code of the address, used only for a miscellaneous (one-off) creditor.","example":"18512"},"countryMiscCreditor":{"type":"string","description":"The country of the address, used only for a miscellaneous (one-off) creditor.","example":"UNITED STATES"},"lines":{"type":"array","description":"The invoice lines. At least one line is required, and the lines must add up to the invoice total.","items":{"$ref":"#/components/schemas/InvoiceDetail"}},"total":{"$ref":"#/components/schemas/InvoiceTrailer"}},"description":"InvoiceHeader, a single accounts payable (creditor) invoice, with its lines, texts and totals. The examples below are taken from HarperCollins USA invoice I1259311."},"InvoiceText":{"type":"object","properties":{"text":{"type":"string","description":"The text. One object per line of text, maximum 72 characters per line.","example":"IMPORT SHIPMENT - 21 CARTONS"}},"description":"InvoiceText, a line of free format text attached to an accounts payable invoice line."},"InvoiceTrailer":{"type":"object","properties":{"recordCount":{"type":"number","description":"The number of invoice lines supplied. Must equal the number of objects in 'lines'.","example":1},"totalInclVat":{"type":"number","description":"The sum of the line totals including tax/VAT, as an unsigned amount. Must equal documentTotInclVat on the header.","example":2198.88},"indicatorForTotalInclVat":{"type":"string","description":"The sign of totalInclVat, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"vatTotal":{"type":"number","description":"The sum of the line tax/VAT totals, as an unsigned amount. Must equal vatTot on the header.","example":0.0},"indicatorForVatTotal":{"type":"string","description":"The sign of vatTotal, '+' for a debit (invoice) or '-' for a credit.","example":"+"},"sourceOfDocument":{"type":"string","description":"This identifies the source system sending the batch/invoice, eg. 'acumatica', 'fraxion'. This will be issued to you by the customer and is used to trace the batch/invoice back to its source.","example":"acumatica"}},"description":"InvoiceTrailer, the control totals of an accounts payable invoice. These are checked against the lines supplied and the invoice is rejected where they do not agree."},"NextKeyRequest":{"type":"object","properties":{"key":{"type":"string"},"sel1":{"type":"string"},"sel2":{"type":"string"},"sel3":{"type":"string"},"id":{"type":"string"},"rtnVal":{"type":"string"},"errCod":{"type":"string"}}},"ControlDetail":{"type":"object","properties":{"controlDetailPK":{"$ref":"#/components/schemas/ControlDetailPK"},"description":{"type":"string"},"status":{"type":"string"}}},"ControlDetailPK":{"type":"object","properties":{"applicationId":{"type":"string"},"key":{"type":"string"},"code":{"type":"string"}}},"Item":{"type":"object","properties":{"itemClass":{"type":"string"},"itemDivision":{"type":"string"},"itemGroup":{"type":"string"},"itemCategory":{"type":"string"},"itemSubcategory":{"type":"string"},"itemCode":{"type":"string"},"alternateItem":{"type":"string"},"supplierItemCode":{"type":"string"},"itemDescription":{"type":"string"},"extendedDescription":{"type":"string"},"comment":{"type":"string"},"stockReport":{"type":"string"},"brandCode":{"type":"string"},"profileCode":{"type":"string"},"itemDiscountClass":{"type":"string"},"exfactoryExchangeCurr":{"type":"string"},"countryOfOrigin":{"type":"string"},"language":{"type":"string"},"unitOfMeasure":{"type":"string"},"pricePer":{"type":"number"},"costPer":{"type":"number"},"packagingType":{"type":"string"},"releaseNumber":{"type":"string"},"editionType":{"type":"string"},"overseasReleaseDate":{"type":"string","format":"date-time"},"costingMethodCode":{"type":"string"},"packSystemIdentifier":{"type":"string"},"abcClass":{"type":"string"},"stockItemyn":{"type":"string"},"itemLocationCategory":{"type":"string"},"putawayCategory":{"type":"string"},"localProductionFlag":{"type":"string"},"ctnsFromBulkFlag":{"type":"string"},"chargeFreight":{"type":"string"},"itemStatus":{"type":"string"},"buyingMethod":{"type":"string"},"exfactoryCost":{"type":"number"},"exfactoryDiscount":{"type":"number"},"overseasPrice":{"type":"number"},"dutyRate":{"type":"number"},"tariffCode":{"type":"string"},"itemGlCode":{"type":"string"},"cartonQuantity":{"type":"number"},"volume":{"type":"number"},"volumetricWght":{"type":"number"},"weightNet":{"type":"number"},"weightGross":{"type":"number"},"length":{"type":"number"},"width":{"type":"number"},"depth":{"type":"number"},"extentValue":{"type":"number"},"extentUnit":{"type":"string"},"itemBarcode":{"type":"string"},"itemWarehouseSelectionCode":{"type":"string"},"taxCode1":{"type":"string"},"taxCode2":{"type":"string"},"taxCode3":{"type":"string"},"taxCode4":{"type":"string"},"taxCode5":{"type":"string"},"taxPortion1":{"type":"number"},"taxPortion2":{"type":"number"},"taxPortion3":{"type":"number"},"taxPortion4":{"type":"number"},"taxPortion5":{"type":"number"},"registrationTimestamp":{"$ref":"#/components/schemas/TimestampPair"},"registrationUser":{"type":"string"},"changeTimestamp":{"$ref":"#/components/schemas/TimestampPair"},"changeUser":{"type":"string"},"itemTemplateId":{"type":"string"}}},"TimestampPair":{"type":"object","properties":{"activityTimeZoneAbbr":{"type":"string"},"activityTimeZoneOffset":{"type":"string"},"activityLocalDateTime":{"type":"string","format":"date-time"},"activityZonedDateTime":{"type":"string","format":"date-time"}}},"ApTransaction":{"type":"object","properties":{"originalDocumentDate":{"type":"string","format":"date-time"},"originalDocumentType":{"type":"string"},"originalDocumentNo":{"type":"string"},"sequenceNumber":{"type":"number"},"documentDate":{"type":"string","format":"date-time"},"documentType":{"type":"string"},"documentNo":{"type":"string"},"batchNumber":{"type":"string"},"batchReference":{"type":"string"},"batchDate":{"type":"string","format":"date-time"},"dueDateCode":{"type":"number"},"calculatedDueDate":{"type":"string","format":"date-time"},"creditorName":{"type":"string"},"customerReference":{"type":"string"},"status":{"type":"string"},"netAmountBase":{"type":"number"},"taxAmountBase":{"type":"number"},"discountAmountBase":{"type":"number"},"outstandingAmtBase":{"type":"number"},"payAmountBase":{"type":"number"},"currencyExchangeCode":{"type":"string"},"currencyExchangeRate":{"type":"number"},"netAmountForeign":{"type":"number"},"taxAmountForeign":{"type":"number"},"discountAmtForeign":{"type":"number"},"osAmtForeign":{"type":"number"},"payAmountForeign":{"type":"number"},"creditorNumber":{"type":"string"}}}}}}