openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 2.21 MB
JSON
{"openapi":"3.0.0","servers":[{"url":"/API"}],"x-hasEquivalentPaths":true,"info":{"title":"Visma Net API","version":"9.66.02.1023","x-apisguru-categories":["enterprise"],"x-logo":{"url":"https://assets-global.website-files.com/6305e092bc95bebe63ae6578/638e0482f8330e6e1039283e_mle_16-9-full-4487_169.jpg"},"x-origin":[{"format":"swagger","url":"https://integration.visma.net/API-index/doc/swagger","version":"2.0"}],"x-providerName":"visma.net"},"paths":{"/controller/api/v1/GeneralLedgerTransactions":{"get":{"operationId":"GeneralLedgerTransactions_GetAll","parameters":[{"description":"The branch CD","in":"query","name":"branch","required":false,"schema":{"type":"string"}},{"description":"Mandatory. The ledger in which you want to view the account balances.","in":"query","name":"ledger","required":true,"schema":{"type":"string"}},{"description":"The financial period that begins the date range of the batches you want to view. Format YYYYPP","in":"query","name":"fromPeriod","required":false,"schema":{"type":"string"}},{"description":"The financial period that ends the date range of the batches you want to view. Format YYYYPP","in":"query","name":"toPeriod","required":false,"schema":{"type":"string"}},{"description":"The account CD for which you want to view activities in the selected financial period.","in":"query","name":"account","required":false,"schema":{"type":"string"}},{"description":"The Subaccount","in":"query","name":"subaccountId","required":false,"schema":{"type":"string"}},{"description":"The first date of the interval within the period. Format YYYY-MM-DD","in":"query","name":"fromDate","required":false,"schema":{"type":"string"}},{"description":"The last date of the interval within the selected period. Format YYYY-MM-DD","in":"query","name":"toDate","required":false,"schema":{"type":"string"}},{"description":"Checkmark indicating if unposted batches are included.","in":"query","name":"includeUnposted","required":false,"schema":{"type":"boolean"}},{"description":"Checkmark indicating if unreleased (balanced) batches are included.","in":"query","name":"includeUnreleased","required":false,"schema":{"type":"boolean"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"skipRecords","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"numberToRead","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTime","required":false,"schema":{"type":"string"}},{"description":"This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTimeCondition","required":false,"schema":{"type":"string"}},{"description":"By default, if no value is provided, False and the account information will include only Number, Description, Type and GlConsolAccountCD.\r\nIf True, each transaction returned will include extended information about account.","in":"query","name":"expandAccountInfo","required":false,"schema":{"type":"boolean"}},{"description":"By default, if no value is provided, False and branch information will include only branch number.\r\nIf True, each transaction returned will include extended information about Branch (number and name).","in":"query","name":"expandBranchInfo","required":false,"schema":{"type":"boolean"}},{"description":"By default, if no value is provided, False and the transactions returned will not include their balances (fields BegBalance, EndingBalance, CurrBegBalance, CurrEndingBalance)\r\nIf True, each transaction returned will include its balance.","in":"query","name":"includeTransactionBalance","required":false,"schema":{"type":"boolean"}},{"description":"Pagination parameter. Page number.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/GeneralLedgerTransactionDetailsDto"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/GeneralLedgerTransactionDetailsDto"},"type":"array"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a range of General Ledger Transactions - ScreenId=GL404000\r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.","tags":["GeneralLedgerTransactions"]}},"/controller/api/v1/KitSpecifications":{"get":{"operationId":"KitSpecifications_GetAll","parameters":[{"in":"query","name":"lastModifiedDateTime","required":false,"schema":{"type":"string"}},{"in":"query","name":"lastModifiedDateTimeCondition","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdDateTime","required":false,"schema":{"type":"string"}},{"in":"query","name":"createdDateTimeCondition","required":false,"schema":{"type":"string"}},{"in":"query","name":"kitInventoryID","required":false,"schema":{"type":"string"}},{"in":"query","name":"revisionID","required":false,"schema":{"type":"string"}},{"description":"Pagination parameter. Page number.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePaginationDtoOfKitSpecificationDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BasePaginationDtoOfKitSpecificationDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a range of Kit Specifications - ScreenId = IN209500","tags":["KitSpecifications"]},"post":{"description":"Response Message has StatusCode Created if POST operation succeed","operationId":"KitSpecifications_Post","parameters":[{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}}},"description":"Defines the data for the KitSpecification to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"Created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:create"]}],"summary":"Creates a KitSpecification","tags":["KitSpecifications"]}},"/controller/api/v1/KitSpecifications/{kitInventoryID}":{"get":{"description":"Data for the INKitSpecHdr","operationId":"KitSpecifications_GetBykitInventoryID","parameters":[{"description":"kitInventoryID","in":"path","name":"kitInventoryID","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BasePaginationDtoOfKitSpecificationDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BasePaginationDtoOfKitSpecificationDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get all revisions for a specific KitSpecification","tags":["KitSpecifications"]}},"/controller/api/v1/KitSpecifications/{kitInventoryID}/{revisionID}":{"get":{"description":"Data for the INKitSpecHdr","operationId":"KitSpecifications_GetBykitInventoryIDrevisionID","parameters":[{"description":"kitInventoryID","in":"path","name":"kitInventoryID","required":true,"schema":{"type":"string"}},{"description":"revisionID","in":"path","name":"revisionID","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a specific KitSpecification","tags":["KitSpecifications"]},"put":{"description":"Response Message has StatusCode NoContent if PUT operation succeed","operationId":"KitSpecifications_PutBykitInventoryIDrevisionID","parameters":[{"description":"kitInventoryID","in":"path","name":"kitInventoryID","required":true,"schema":{"type":"string"}},{"description":"revisionID","in":"path","name":"revisionID","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/KitSpecificationUpdateDto"}}},"description":"The data to update for the KitSpecification","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."},"204":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"NoContent"}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Updates a specific KitSpecification","tags":["KitSpecifications"]}},"/controller/api/v1/PurchaseReceipt":{"get":{"operationId":"PurchaseReceipt_GetAllReceiptBasic","parameters":[{"in":"query","name":"receiptType","required":false,"schema":{"enum":["PoReceipt","PoReturn","TransferReceipt"],"type":"string"}},{"in":"query","name":"status","required":false,"schema":{"enum":["Hold","Balanced","Released"],"type":"string"}},{"in":"query","name":"greaterThanValue","required":false,"schema":{"type":"string"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"numberToRead","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"skipRecords","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTime","required":false,"schema":{"type":"string"}},{"description":"This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTimeCondition","required":false,"schema":{"type":"string"}},{"in":"query","name":"supplier","required":false,"schema":{"type":"string"}},{"in":"query","name":"poOrderNbr","required":false,"schema":{"type":"string"}},{"description":"Pagination parameter. Page number.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PurchaseReceiptDto"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/PurchaseReceiptDto"},"type":"array"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a range of Purchase Receipts - ScreenId=PO302000\r\nPlease use a page size lower or equal to the allowed max page size which is 500","tags":["PurchaseReceipt"]},"post":{"description":"Response Message has StatusCode Created if POST operation succeed","operationId":"PurchaseReceipt_Post","parameters":[{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}}},"description":"Defines the data for the Purchase Receipt to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"Created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:create"]}],"summary":"Create a Purchase Receipt","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceipt/{receiptNumber}":{"get":{"operationId":"PurchaseReceipt_GetPurchaseReceiptBasicByreceiptNumber","parameters":[{"description":"Identifies the Purchase Receipt","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a specific Purchase Receipt","tags":["PurchaseReceipt"]},"put":{"description":"Response Message has StatusCode NoContent if PUT operation succeed","operationId":"PurchaseReceipt_PutByreceiptNumber","parameters":[{"description":"Identifies the Purchase Receipt to update","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptUpdateDto"}}},"description":"Defines the data for the Purchase Receipt to update","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."},"204":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"NoContent"}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Update a specific Purchase Receipt","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder":{"post":{"description":"The action result DTO contains information about the result of running the action","operationId":"PurchaseReceipt_AddPurchaseOrdersByreceiptNumber","parameters":[{"description":"Reference number of the receipt to which to add the orders","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderListUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderListUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderListUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderListUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderListUpdateDto"}}},"description":"Object containing an array of reference numbers of the orders to be added to the receipt","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Add purchase orders to receipt","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines":{"post":{"description":"The action result dto contains information about the result of running the action","operationId":"PurchaseReceipt_AddPurchaseOrderLinesByreceiptNumber","parameters":[{"description":"Reference number of the receipt to which to add the orders","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto"}}},"description":"Object containing an array of reference numbers of the orders to be added to the receipt","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Add purchase order lines to receipt","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/release":{"post":{"description":"The action result dto contains information about the result of running the action","operationId":"PurchaseReceipt_ReleaseInvoiceByreceiptNumber","parameters":[{"description":"Reference number of the receipt to be released","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Release purchase receipt operation","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceipt/{receiptNumber}/print":{"get":{"operationId":"PurchaseReceipt_PrintPurchaseReceiptByreceiptNumber","parameters":[{"description":"Identifies the receipt","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get the print report of a Purchase Receipt","tags":["PurchaseReceipt"]}},"/controller/api/v1/PurchaseReceiptBasic":{"get":{"operationId":"PurchaseReceiptBasic_GetAllReceiptBasic","parameters":[{"in":"query","name":"receiptType","required":false,"schema":{"enum":["PoReceipt","PoReturn","TransferReceipt"],"type":"string"}},{"in":"query","name":"status","required":false,"schema":{"enum":["Hold","Balanced","Released"],"type":"string"}},{"in":"query","name":"greaterThanValue","required":false,"schema":{"type":"string"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"numberToRead","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.","in":"query","name":"skipRecords","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTime","required":false,"schema":{"type":"string"}},{"description":"This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTimeCondition","required":false,"schema":{"type":"string"}},{"in":"query","name":"supplier","required":false,"schema":{"type":"string"}},{"in":"query","name":"poOrderNbr","required":false,"schema":{"type":"string"}},{"description":"Pagination parameter. Page number.","in":"query","name":"pageNumber","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.","in":"query","name":"pageSize","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PurchaseReceiptBasicDto"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/PurchaseReceiptBasicDto"},"type":"array"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a range with purchase receipts, ScreenId=PO302000\r\nPlease use a page size lower or equal to the allowed max page size which is 500","tags":["PurchaseReceiptBasic"]},"post":{"description":"Response Message has StatusCode Created if POST operation succeed","operationId":"PurchaseReceiptBasic_Post","parameters":[{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}}},"description":"Defines the data for the Purchase Receipt to create","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"Created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:create"]}],"summary":"Create a Purchase Receipt","tags":["PurchaseReceiptBasic"]}},"/controller/api/v1/PurchaseReceiptBasic/{receiptNumber}":{"get":{"operationId":"PurchaseReceiptBasic_GetPurchaseReceiptBasicByreceiptNumber","parameters":[{"description":"Identifies the Purchase Receipt","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a specific Purchase Receipt","tags":["PurchaseReceiptBasic"]},"put":{"description":"Response Message has StatusCode NoContent if PUT operation succeed","operationId":"PurchaseReceiptBasic_PutByreceiptNumber","parameters":[{"description":"Identifies the Purchase Receipt to update","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/PurchaseReceiptBasicUpdateDto"}}},"description":"Defines the data for the Purchase Receipt to update","required":true},"responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."},"204":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"NoContent"}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Update a specific Purchase Receipt","tags":["PurchaseReceiptBasic"]}},"/controller/api/v1/PurchaseReceiptBasic/{receiptNumber}/action/release":{"post":{"description":"The action result dto contains information about the result of running the action","operationId":"PurchaseReceiptBasic_ReleaseInvoiceByreceiptNumber","parameters":[{"description":"Reference number of the receipt to be released","in":"path","name":"receiptNumber","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/ReleasePurchaseReceiptActionResultDto"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:update"]}],"summary":"Release purchase receipt operation","tags":["PurchaseReceiptBasic"]}},"/controller/api/v1/account":{"get":{"operationId":"Account_GetAll","parameters":[{"description":"Set to True to select active accounts.","in":"query","name":"active","required":false,"schema":{"type":"boolean"}},{"description":"Enter the from-value for Account no.","in":"query","name":"greaterThanValue","required":false,"schema":{"type":"string"}},{"description":"Filter by the Public code 1, authorities mapped code to the account.","in":"query","name":"publicCode","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"Filter by External code 1 (field used for sorting and inquiries.)","in":"query","name":"externalCode1","required":false,"schema":{"type":"string"}},{"description":"Filter by External code 2 (field used for sorting and inquiries.)","in":"query","name":"externalCode2","required":false,"schema":{"type":"string"}},{"description":"Filter by Analysis code (field used for sorting and inquiries.)","in":"query","name":"analysisCode","required":false,"schema":{"type":"string"}},{"description":"This field has been deprecated and will be removed in future versions.","in":"query","name":"numberToRead","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This field has been deprecated and will be removed in future versions.","in":"query","name":"skipRecords","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTime","required":false,"schema":{"type":"string"}},{"description":"This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.","in":"query","name":"lastModifiedDateTimeCondition","required":false,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AccountDto"},"type":"array"}},"application/xml":{"schema":{"items":{"$ref":"#/components/schemas/AccountDto"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/AccountDto"},"type":"array"}},"text/xml":{"schema":{"items":{"$ref":"#/components/schemas/AccountDto"},"type":"array"}}},"description":"OK"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:read"]}],"summary":"Get a range of General ledger accounts - ScreenId=GL202500","tags":["Account"]},"post":{"description":"Response Message has StatusCode Created if POST operation succeed","operationId":"Account_Post","parameters":[{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountUpdateDto"}},"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/AccountUpdateDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountUpdateDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/AccountUpdateDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AccountUpdateDto"}}},"description":"Defines the fields and field values to be set on created account","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"type":"object"}},"text/json":{"schema":{"type":"object"}}},"description":"Created"},"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/BackgroundApiAcceptedDto"}}},"description":"Server accepted and queued the request for background execution."}},"security":[{"oauth2":["vismanet_erp_interactive_api:create"]}],"summary":"Creates an account","tags":["Account"]}},"/controller/api/v1/account/{accountCd}":{"get":{"operationId":"Account_GetByaccountCd","parameters":[{"description":"Return the Information from Chart of account for the specified AccountCD","in":"path","name":"accountCd","required":true,"schema":{"type":"string"}},{"description":"If a URL value is provided, then API endpoint will be queued and executed in background. When the execution of the background operation is finished, the system will POST the response to the specified URL. The endpoint itself responds in this case with a 202-Accepted status and a reference to a state document for the background operation.","in":"header","name":"erp-api-background","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}},"application/xml":{"schema":{"$ref":"#/components/schemas/AccountDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/AccountDto"}},"text/xml":{"schema":{"$ref":"#/components/schemas/AccountDto"}}},"