SAP Business One Component
Manage business partners, orders, inventory, and financial data in SAP Business One.
Component key: sap-business-one
Description
SAP Business One is an integrated enterprise resource planning (ERP) solution designed for organizations to manage their entire operations.
This component allows you to manage business partners, sales orders, purchase orders, and inventory items within SAP Business One.
API Documentation
This component was built using the SAP Business One Service Layer API, supporting both V1 (/b1s/v1 - OData 3.0) and V2 (/b1s/v2 - OData 4.0) endpoints. You can configure the API version in your connection settings.
Additional resources:
Connections
SAP Business One Authentication
key: sap-business-one-authSAP Business One uses username and password authentication to connect to the Service Layer API. The Service Layer supports two API versions: v2 (OData 4.0, recommended for new integrations) and v1 (OData 3.0, the default for backwards compatibility).
For detailed information about the SAP Business One Service Layer API, refer to the Service Layer API Reference.
Prerequisites
- Access to a SAP Business One instance (cloud or on-premises)
- SAP Business One user account with API access permissions
- For cloud instances: Server address including hostname/IP and port
- For on-premises instances: Network access to the SAP Business One server via the on-premises agent
Setup Steps
Gather the following information from the SAP Business One administrator:
- Username and Password: SAP Business One user credentials with appropriate API permissions
- Server Address (for cloud/non-OnPrem instances):
- Format:
https://<Server Name/IP>:<Port> - Example:
https://sapb1-server.example.com:50000
- Format:
- Database Instance (optional):
- Format:
<DatabaseName>@<Host>:<Port> - Example:
C200@10.58.114.200:30013
- Format:
- Company Name (optional):
- The company database name to connect to
- Example:
SBODEMOUS
- API Version:
- v1 (OData 3.0) - Default, for backwards compatibility with existing integrations
- v2 (OData 4.0) - Recommended for new integrations with improved functionality
Configure the Connection
| Field | Required | Description |
|---|---|---|
| Username | Yes | The SAP Business One username for authentication |
| Password | Yes | The SAP Business One password for authentication |
| Server Address | No* | The URL of the SAP Business One Service Layer server, including the port. Required for non-OnPrem connections. Example: https://sapb1-server.example.com:50000 |
| Database Instance | No | The SAP HANA database instance in format DatabaseName@Host:Port. Example: C200@10.58.114.200:30013 |
| Company Name | No | The company database name to connect to in SAP Business One. Example: SBODEMOUS |
| API Version | No | The Service Layer API version to use. Defaults to v1 (OData 3.0). Select v2 (OData 4.0) for new integrations |
*Required for cloud deployments. For on-premises deployments, the Host and Port fields are automatically configured by the on-premises agent.
On-prem enabled: this connection can be configured to connect to an on-prem resource on a private network. Learn more.
| Input | Notes | Example |
|---|---|---|
| API Version | The Service Layer API version to use. v2 (OData 4.0) is recommended for new integrations and provides improved functionality. v1 (OData 3.0) is available for backwards compatibility with existing integrations. | v1 |
| Company Name | The company database name to connect to in SAP Business One. | SBODEMOUS |
| Database Instance | The SAP HANA database instance to connect to, in the format DatabaseName@Host:Port. | C200@10.58.114.200:30013 |
| Host | The IP address or hostname of your On-Prem server. | sapb1-onprem.example.io |
| Password | The SAP Business One password for authentication. | Password |
| Port | The port number of your On-Prem server. | 50000 |
| Server Address | The URL of the SAP Business One Service Layer server, including the port (e.g., https://sapb1-server.example.com:50000). Required for non-OnPrem connections. See SAP Business One Service Layer documentation for details. | https://sapb1-server.example.com:50000 |
| Username | The SAP Business One username for authentication. | TestUser |
Data Sources
Select Business Partner
Select a Business Partner from a dropdown menu. | key: selectBusinessPartner | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. |
{
"result": [
{
"key": "C01305",
"label": "Anmol Steps – Bijolia(EL)"
}
]
}
Select Invoice
Select an Invoice from a dropdown menu. | key: selectInvoice | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. |
{
"result": [
{
"key": "10689",
"label": "10689"
}
]
}
Select Order
Select an Order from a dropdown menu. | key: selectOrder | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. |
{
"result": [
{
"key": "10689",
"label": "10689"
}
]
}
Select Purchase Order
Select an Purchase Order from a dropdown menu. | key: selectPurchaseOrder | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. |
{
"result": [
{
"key": "10689",
"label": "10689"
}
]
}
Select Record
Select a Custom Record type from a dropdown menu. | key: selectRecord | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. | |
| Key Field | The field name to use as the value in dropdown options. | ItemCode |
| Label Field | The field name to use as the label text in dropdown options. | ItemName |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
{
"result": [
{
"key": "C01305",
"label": "Anmol Steps – Bijolia(EL)"
}
]
}
Select Warehouse
Select a Warehouse from a dropdown menu. | key: selectWarehouse | type: picklist
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Connection | The SAP Business One connection to use. |
{
"result": [
{
"key": "Del-02",
"label": "AnBadapur - Rejection warehouse"
}
]
}
Actions
Close Invoice
Invoke the method Close. | key: closeInvoice
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Entry | The document entry number (DocEntry) that uniquely identifies the invoice. This is an integer value. | 12345 |
Create Business Partner
Create an instance of Business Partners | key: createBusinessPartner
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Card Name | The name of the business partner (customer or supplier). | Acme Corporation |
| Card Type | The type of the business partner: Customer (cCustomer), Supplier (cSupplier), or Lead (cLid). | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"odata.etag": "W/\"356A192B7913B04C54574D18C28D46E6395428AB\"",
"CardCode": "C01305",
"CardName": "Anmol Steps – Bijolia(EL)",
"CardType": "cCustomer",
"GroupCode": 112,
"Address": "Bundi Road, Bijolia",
"ZipCode": "311602",
"MailAddress": "Bundi Road, Bijolia",
"MailZipCode": "311602",
"Phone1": "9460351521",
"Phone2": null,
"Fax": null,
"ContactPerson": "Anmol Steps – Bijolia(EL)",
"Notes": null,
"PayTermsGrpCode": 5,
"CreditLimit": 0,
"MaxCommitment": 0,
"DiscountPercent": 0,
"VatLiable": "vLiable",
"FederalTaxID": null,
"DeductibleAtSource": "tNO",
"DeductionPercent": 0,
"DeductionValidUntil": null,
"PriceListNum": 19,
"IntrestRatePercent": 0,
"CommissionPercent": 0,
"CommissionGroupCode": 0,
"FreeText": null,
"SalesPersonCode": -1,
"Currency": "INR",
"RateDiffAccount": "",
"Cellular": "9460351521",
"AvarageLate": null,
"City": "Bijolia",
"County": null,
"Country": "IN",
"MailCity": "Bijolia",
"MailCounty": null,
"MailCountry": "IN",
"EmailAddress": null,
"Picture": null,
"DefaultAccount": null,
"DefaultBranch": null,
"DefaultBankCode": "-1",
"AdditionalID": null,
"Pager": null,
"FatherCard": "C01169",
"CardForeignName": null,
"FatherType": "cDelivery_sum",
"DeductionOffice": null,
"ExportCode": null,
"MinIntrest": 0,
"CurrentAccountBalance": 0,
"OpenDeliveryNotesBalance": 0,
"OpenOrdersBalance": 0,
"OpenChecksBalance": 0,
"VatGroup": null,
"ShippingType": null,
"Password": null,
"Indicator": null,
"IBAN": null,
"CreditCardCode": -1,
"CreditCardNum": null,
"CreditCardExpiration": null,
"DebitorAccount": "_SYS00000000037",
"OpenOpportunities": null,
"Valid": "tYES",
"ValidFrom": null,
"ValidTo": null,
"ValidRemarks": null,
"Frozen": "tNO",
"FrozenFrom": null,
"FrozenTo": null,
"FrozenRemarks": null,
"Block": null,
"BillToState": "RJ",
"ShipToState": "RJ",
"ExemptNum": null,
"Priority": -1,
"FormCode1099": null,
"Box1099": null,
"PeymentMethodCode": null,
"BackOrder": "tYES",
"PartialDelivery": "tYES",
"BlockDunning": "tNO",
"BankCountry": null,
"HouseBank": null,
"HouseBankCountry": "IN",
"HouseBankAccount": null,
"ShipToDefault": "Anmol Steps – Bijolia(EL)",
"DunningLevel": null,
"DunningDate": null,
"CollectionAuthorization": "tNO",
"DME": null,
"InstructionKey": null,
"SinglePayment": "tNO",
"ISRBillerID": null,
"PaymentBlock": "tNO",
"ReferenceDetails": null,
"HouseBankBranch": null,
"OwnerIDNumber": null,
"PaymentBlockDescription": -1,
"TaxExemptionLetterNum": null,
"MaxAmountOfExemption": 0,
"ExemptionValidityDateFrom": null,
"ExemptionValidityDateTo": null,
"LinkedBusinessPartner": null,
"LastMultiReconciliationNum": null,
"DeferredTax": "tNO",
"Equalization": "tNO",
"SubjectToWithholdingTax": "boNO",
"CertificateNumber": null,
"ExpirationDate": null,
"NationalInsuranceNum": null,
"AccrualCriteria": "tNO",
"WTCode": null,
"BillToBuildingFloorRoom": "",
"DownPaymentClearAct": "_SYS00000000084",
"ChannelBP": null,
"DefaultTechnician": null,
"BilltoDefault": "Anmol Steps – Bijolia(EL)",
"CustomerBillofExchangDisc": null,
"Territory": null,
"ShipToBuildingFloorRoom": "",
"CustomerBillofExchangPres": null,
"ProjectCode": null,
"VatGroupLatinAmerica": null,
"DunningTerm": null,
"Website": null,
"OtherReceivablePayable": null,
"BillofExchangeonCollection": null,
"CompanyPrivate": "cCompany",
"LanguageCode": 8,
"UnpaidBillofExchange": null,
"WithholdingTaxDeductionGroup": -1,
"ClosingDateProcedureNumber": null,
"Profession": null,
"BankChargesAllocationCode": null,
"TaxRoundingRule": "trr_CompanyDefault",
"Properties1": "tNO",
"Properties2": "tNO",
"Properties3": "tNO",
"Properties4": "tNO",
"Properties5": "tNO",
"Properties6": "tNO",
"Properties7": "tNO",
"Properties8": "tNO",
"Properties9": "tNO",
"Properties10": "tNO",
"Properties11": "tNO",
"Properties12": "tNO",
"Properties13": "tNO",
"Properties14": "tNO",
"Properties15": "tNO",
"Properties16": "tNO",
"Properties17": "tNO",
"Properties18": "tNO",
"Properties19": "tNO",
"Properties20": "tNO",
"Properties21": "tNO",
"Properties22": "tNO",
"Properties23": "tNO",
"Properties24": "tNO",
"Properties25": "tNO",
"Properties26": "tNO",
"Properties27": "tNO",
"Properties28": "tNO",
"Properties29": "tNO",
"Properties30": "tNO",
"Properties31": "tNO",
"Properties32": "tNO",
"Properties33": "tNO",
"Properties34": "tNO",
"Properties35": "tNO",
"Properties36": "tNO",
"Properties37": "tNO",
"Properties38": "tNO",
"Properties39": "tNO",
"Properties40": "tNO",
"Properties41": "tNO",
"Properties42": "tNO",
"Properties43": "tNO",
"Properties44": "tNO",
"Properties45": "tNO",
"Properties46": "tNO",
"Properties47": "tNO",
"Properties48": "tNO",
"Properties49": "tNO",
"Properties50": "tNO",
"Properties51": "tNO",
"Properties52": "tNO",
"Properties53": "tNO",
"Properties54": "tNO",
"Properties55": "tNO",
"Properties56": "tNO",
"Properties57": "tNO",
"Properties58": "tNO",
"Properties59": "tNO",
"Properties60": "tNO",
"Properties61": "tNO",
"Properties62": "tNO",
"Properties63": "tNO",
"Properties64": "tNO",
"CompanyRegistrationNumber": null,
"VerificationNumber": null,
"DiscountBaseObject": "dgboNone",
"DiscountRelations": "dgrLowestDiscount",
"TypeReport": "atCompany",
"ThresholdOverlook": "tNO",
"SurchargeOverlook": "tNO",
"DownPaymentInterimAccount": "_SYS00000000054",
"OperationCode347": "ocSalesOrServicesRevenues",
"InsuranceOperation347": "tNO",
"HierarchicalDeduction": "tNO",
"ShaamGroup": "sgServicesAndAsset",
"WithholdingTaxCertified": "tNO",
"BookkeepingCertified": "tNO",
"PlanningGroup": null,
"Affiliate": "tNO",
"Industry": null,
"VatIDNum": null,
"DatevAccount": null,
"DatevFirstDataEntry": "tYES",
"UseShippedGoodsAccount": "tNO",
"GTSRegNo": null,
"GTSBankAccountNo": null,
"GTSBillingAddrTel": null,
"ETaxWebSite": null,
"HouseBankIBAN": "",
"VATRegistrationNumber": null,
"RepresentativeName": null,
"IndustryType": null,
"BusinessType": null,
"Series": 85,
"AutomaticPosting": null,
"InterestAccount": null,
"FeeAccount": null,
"CampaignNumber": null,
"AliasName": null,
"DefaultBlanketAgreementNumber": null,
"EffectiveDiscount": "dgrLowestDiscount",
"NoDiscounts": "tNO",
"EffectivePrice": "epDefaultPriority",
"EffectivePriceConsidersPriceBeforeDiscount": "tNO",
"GlobalLocationNumber": null,
"EDISenderID": null,
"EDIRecipientID": null,
"ResidenNumber": "rntSpanishFiscalID",
"RelationshipCode": null,
"RelationshipDateFrom": null,
"RelationshipDateTill": null,
"UnifiedFederalTaxID": null,
"AttachmentEntry": null,
"TypeOfOperation": null,
"EndorsableChecksFromBP": "tYES",
"AcceptsEndorsedChecks": "tNO",
"OwnerCode": null,
"BlockSendingMarketingContent": "tNO",
"AgentCode": null,
"PriceMode": null,
"EDocGenerationType": null,
"EDocStreet": null,
"EDocStreetNumber": null,
"EDocBuildingNumber": null,
"EDocZipCode": null,
"EDocCity": null,
"EDocCountry": null,
"EDocDistrict": null,
"EDocRepresentativeFirstName": null,
"EDocRepresentativeSurname": null,
"EDocRepresentativeCompany": null,
"EDocRepresentativeFiscalCode": null,
"EDocRepresentativeAdditionalId": null,
"EDocPECAddress": null,
"IPACodeForPA": null,
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:49",
"ExemptionMaxAmountValidationType": "emaIndividual",
"ECommerceMerchantID": null,
"UseBillToAddrToDetermineTax": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"DefaultTransporterEntry": 0,
"DefaultTransporterLineNumber": 0,
"FCERelevant": "tNO",
"FCEValidateBaseDelivery": "tNO",
"MainUsage": null,
"EBooksVATExemptionCause": null,
"LegalText": null,
"DataVersion": 1,
"ExchangeRateForIncomingPayment": "tYES",
"ExchangeRateForOutgoingPayment": "tYES",
"CertificateDetails": null,
"DefaultCurrency": null,
"EORINumber": null,
"FCEAsPaymentMeans": "tNO",
"U_Discount": 0,
"U_InterBranch": "N",
"ElectronicProtocols": [],
"BPAddresses": [
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_BillTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 0,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
},
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_ShipTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 1,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
}
],
"ContactEmployees": [
{
"CardCode": "C01305",
"Name": "Anmol Steps – Bijolia(EL)",
"Position": null,
"Address": null,
"Phone1": "9460351521",
"Phone2": null,
"MobilePhone": "9460351521",
"Fax": null,
"E_Mail": null,
"Pager": null,
"Remarks1": null,
"Remarks2": null,
"Password": null,
"InternalCode": 1325,
"PlaceOfBirth": "-1",
"DateOfBirth": null,
"Gender": "gt_Undefined",
"Profession": null,
"Title": null,
"CityOfBirth": null,
"Active": "tYES",
"FirstName": null,
"MiddleName": null,
"LastName": null,
"EmailGroupCode": null,
"BlockSendingMarketingContent": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:00",
"ConnectedAddressName": null,
"ConnectedAddressType": null,
"ForeignCountry": null,
"ContactEmployeeBlockSendingMarketingContents": []
}
],
"BPAccountReceivablePaybleCollection": [],
"BPPaymentMethods": [],
"BPWithholdingTaxCollection": [],
"BPPaymentDates": [],
"BPBranchAssignment": [
{
"BPCode": "C01305",
"BPLID": 2,
"DisabledForBP": "tNO"
},
{
"BPCode": "C01305",
"BPLID": 4,
"DisabledForBP": "tNO"
}
],
"BPBankAccounts": [],
"BPFiscalTaxIDCollection": [
{
"Address": "",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": "",
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": null,
"TaxId1": null,
"TaxId2": null,
"TaxId3": null,
"TaxId4": null,
"TaxId5": null,
"TaxId6": null,
"TaxId7": null,
"TaxId8": null,
"TaxId9": null,
"TaxId10": null,
"TaxId11": null,
"BPCode": "C01305",
"AddrType": "bo_BillTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
}
],
"DiscountGroups": [],
"BPIntrastatExtension": {},
"BPBlockSendingMarketingContents": [],
"BPCurrenciesCollection": []
}
}
Create Invoice
Create an instance of Invoices. | key: createInvoice
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Lines | The document lines containing item details for the order. Each line should include ItemCode, Quantity, and optionally UnitPrice and TaxCode. |
Create Item
Retrieve all or some selected properties from an instance of Items with the given id. | key: createItem
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Item Code | The unique code identifying the item in the inventory. | A00001 |
| Item Name | The name of the item in the inventory. | Desktop Computer |
| Item Type | The type of the item: Items (itItems), Labor (itLabor), Travel (itTravel), or Fixed Assets (itFixedAssets). |
Create Order
Create an instance of Orders. | key: createOrder
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Card Code | The business partner code associated with this order. | C20000 |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Due Date | The due date of the order in YYYY-MM-DD format. | 2026-12-31 |
| Doc Lines | The document lines containing item details for the order. Each line should include ItemCode, Quantity, and optionally UnitPrice and TaxCode. |
Create Price List
Create an instance of Price Lists | key: createPriceList
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Price List Name | The name of the price list. | Retail Price List |
{
"data": {
"RoundingMethod": "borm_NoRounding",
"GroupNum": "boplgn_Group2",
"BasePriceList": 2,
"Factor": 1,
"PriceListNo": 2,
"PriceListName": "Buying Price List",
"IsGrossPrice": "tNO",
"Active": "tYES",
"ValidFrom": null,
"ValidTo": null,
"DefaultPrimeCurrency": "INR",
"DefaultAdditionalCurrency1": "INR",
"DefaultAdditionalCurrency2": "INR",
"RoundingRule": "borrRoundOff",
"FixedAmount": 0
}
}
Create Purchase Order
Create an instance of Purchase Orders. | key: createPurchaseOrder
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Document Lines | The document lines containing item details for the order. Each line should include ItemCode, Quantity, and optionally UnitPrice and TaxCode. |
Create Record
Create a new record in SAP Business One. | key: createRecord
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
Create Warehouse
Create an instance of Warehouses. | key: createWarehouse
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Warehouse Location ID | The unique identifier for the warehouse location. This is an integer value. | 1 |
| Warehouse Code | The unique code identifying the warehouse. | WH01 |
| Warehouse Name | The name of the warehouse. | Main Distribution Center |
Delete Business Partner
Delete an instance of BusinessPartners with the specified id. | key: deleteBusinessPartner
| Input | Notes | Example |
|---|---|---|
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": "DELETED SUCCESSFULLY"
}
Delete Item
Delete an instance of Items with the specified id. | key: deleteItem
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Item Code | The unique code identifying the item in the inventory. | A00001 |
{
"data": "DELETED SUCCESSFULLY"
}
Delete Price List
Delete an instance of Items with the specified id. | key: deletePriceList
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Price List Number | The unique number identifying the price list. This is an integer value. | 1 |
{
"data": "DELETED SUCCESSFULLY"
}
Delete Record
Delete an existing record in SAP Business One. | key: deleteRecord
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Record ID | The unique identifier for the record. This is typically an integer value (DocEntry or similar). | 12345 |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
{
"data": "DELETED SUCCESSFULLY"
}
Delete Warehouse
Delete an instance of Warehouses with the specified id. | key: deleteWarehouse
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Warehouse Code | The unique code identifying the warehouse. | WH01 |
{
"data": "DELETED SUCCESSFULLY"
}
Get Business Partner
Retrieve all or some selected properties from an instance of BusinessPartners with the given id. | key: getBusinessPartner
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": {
"odata.etag": "W/\"356A192B7913B04C54574D18C28D46E6395428AB\"",
"CardCode": "C01305",
"CardName": "Anmol Steps – Bijolia(EL)",
"CardType": "cCustomer",
"GroupCode": 112,
"Address": "Bundi Road, Bijolia",
"ZipCode": "311602",
"MailAddress": "Bundi Road, Bijolia",
"MailZipCode": "311602",
"Phone1": "9460351521",
"Phone2": null,
"Fax": null,
"ContactPerson": "Anmol Steps – Bijolia(EL)",
"Notes": null,
"PayTermsGrpCode": 5,
"CreditLimit": 0,
"MaxCommitment": 0,
"DiscountPercent": 0,
"VatLiable": "vLiable",
"FederalTaxID": null,
"DeductibleAtSource": "tNO",
"DeductionPercent": 0,
"DeductionValidUntil": null,
"PriceListNum": 19,
"IntrestRatePercent": 0,
"CommissionPercent": 0,
"CommissionGroupCode": 0,
"FreeText": null,
"SalesPersonCode": -1,
"Currency": "INR",
"RateDiffAccount": "",
"Cellular": "9460351521",
"AvarageLate": null,
"City": "Bijolia",
"County": null,
"Country": "IN",
"MailCity": "Bijolia",
"MailCounty": null,
"MailCountry": "IN",
"EmailAddress": null,
"Picture": null,
"DefaultAccount": null,
"DefaultBranch": null,
"DefaultBankCode": "-1",
"AdditionalID": null,
"Pager": null,
"FatherCard": "C01169",
"CardForeignName": null,
"FatherType": "cDelivery_sum",
"DeductionOffice": null,
"ExportCode": null,
"MinIntrest": 0,
"CurrentAccountBalance": 0,
"OpenDeliveryNotesBalance": 0,
"OpenOrdersBalance": 0,
"OpenChecksBalance": 0,
"VatGroup": null,
"ShippingType": null,
"Password": null,
"Indicator": null,
"IBAN": null,
"CreditCardCode": -1,
"CreditCardNum": null,
"CreditCardExpiration": null,
"DebitorAccount": "_SYS00000000037",
"OpenOpportunities": null,
"Valid": "tYES",
"ValidFrom": null,
"ValidTo": null,
"ValidRemarks": null,
"Frozen": "tNO",
"FrozenFrom": null,
"FrozenTo": null,
"FrozenRemarks": null,
"Block": null,
"BillToState": "RJ",
"ShipToState": "RJ",
"ExemptNum": null,
"Priority": -1,
"FormCode1099": null,
"Box1099": null,
"PeymentMethodCode": null,
"BackOrder": "tYES",
"PartialDelivery": "tYES",
"BlockDunning": "tNO",
"BankCountry": null,
"HouseBank": null,
"HouseBankCountry": "IN",
"HouseBankAccount": null,
"ShipToDefault": "Anmol Steps – Bijolia(EL)",
"DunningLevel": null,
"DunningDate": null,
"CollectionAuthorization": "tNO",
"DME": null,
"InstructionKey": null,
"SinglePayment": "tNO",
"ISRBillerID": null,
"PaymentBlock": "tNO",
"ReferenceDetails": null,
"HouseBankBranch": null,
"OwnerIDNumber": null,
"PaymentBlockDescription": -1,
"TaxExemptionLetterNum": null,
"MaxAmountOfExemption": 0,
"ExemptionValidityDateFrom": null,
"ExemptionValidityDateTo": null,
"LinkedBusinessPartner": null,
"LastMultiReconciliationNum": null,
"DeferredTax": "tNO",
"Equalization": "tNO",
"SubjectToWithholdingTax": "boNO",
"CertificateNumber": null,
"ExpirationDate": null,
"NationalInsuranceNum": null,
"AccrualCriteria": "tNO",
"WTCode": null,
"BillToBuildingFloorRoom": "",
"DownPaymentClearAct": "_SYS00000000084",
"ChannelBP": null,
"DefaultTechnician": null,
"BilltoDefault": "Anmol Steps – Bijolia(EL)",
"CustomerBillofExchangDisc": null,
"Territory": null,
"ShipToBuildingFloorRoom": "",
"CustomerBillofExchangPres": null,
"ProjectCode": null,
"VatGroupLatinAmerica": null,
"DunningTerm": null,
"Website": null,
"OtherReceivablePayable": null,
"BillofExchangeonCollection": null,
"CompanyPrivate": "cCompany",
"LanguageCode": 8,
"UnpaidBillofExchange": null,
"WithholdingTaxDeductionGroup": -1,
"ClosingDateProcedureNumber": null,
"Profession": null,
"BankChargesAllocationCode": null,
"TaxRoundingRule": "trr_CompanyDefault",
"Properties1": "tNO",
"Properties2": "tNO",
"Properties3": "tNO",
"Properties4": "tNO",
"Properties5": "tNO",
"Properties6": "tNO",
"Properties7": "tNO",
"Properties8": "tNO",
"Properties9": "tNO",
"Properties10": "tNO",
"Properties11": "tNO",
"Properties12": "tNO",
"Properties13": "tNO",
"Properties14": "tNO",
"Properties15": "tNO",
"Properties16": "tNO",
"Properties17": "tNO",
"Properties18": "tNO",
"Properties19": "tNO",
"Properties20": "tNO",
"Properties21": "tNO",
"Properties22": "tNO",
"Properties23": "tNO",
"Properties24": "tNO",
"Properties25": "tNO",
"Properties26": "tNO",
"Properties27": "tNO",
"Properties28": "tNO",
"Properties29": "tNO",
"Properties30": "tNO",
"Properties31": "tNO",
"Properties32": "tNO",
"Properties33": "tNO",
"Properties34": "tNO",
"Properties35": "tNO",
"Properties36": "tNO",
"Properties37": "tNO",
"Properties38": "tNO",
"Properties39": "tNO",
"Properties40": "tNO",
"Properties41": "tNO",
"Properties42": "tNO",
"Properties43": "tNO",
"Properties44": "tNO",
"Properties45": "tNO",
"Properties46": "tNO",
"Properties47": "tNO",
"Properties48": "tNO",
"Properties49": "tNO",
"Properties50": "tNO",
"Properties51": "tNO",
"Properties52": "tNO",
"Properties53": "tNO",
"Properties54": "tNO",
"Properties55": "tNO",
"Properties56": "tNO",
"Properties57": "tNO",
"Properties58": "tNO",
"Properties59": "tNO",
"Properties60": "tNO",
"Properties61": "tNO",
"Properties62": "tNO",
"Properties63": "tNO",
"Properties64": "tNO",
"CompanyRegistrationNumber": null,
"VerificationNumber": null,
"DiscountBaseObject": "dgboNone",
"DiscountRelations": "dgrLowestDiscount",
"TypeReport": "atCompany",
"ThresholdOverlook": "tNO",
"SurchargeOverlook": "tNO",
"DownPaymentInterimAccount": "_SYS00000000054",
"OperationCode347": "ocSalesOrServicesRevenues",
"InsuranceOperation347": "tNO",
"HierarchicalDeduction": "tNO",
"ShaamGroup": "sgServicesAndAsset",
"WithholdingTaxCertified": "tNO",
"BookkeepingCertified": "tNO",
"PlanningGroup": null,
"Affiliate": "tNO",
"Industry": null,
"VatIDNum": null,
"DatevAccount": null,
"DatevFirstDataEntry": "tYES",
"UseShippedGoodsAccount": "tNO",
"GTSRegNo": null,
"GTSBankAccountNo": null,
"GTSBillingAddrTel": null,
"ETaxWebSite": null,
"HouseBankIBAN": "",
"VATRegistrationNumber": null,
"RepresentativeName": null,
"IndustryType": null,
"BusinessType": null,
"Series": 85,
"AutomaticPosting": null,
"InterestAccount": null,
"FeeAccount": null,
"CampaignNumber": null,
"AliasName": null,
"DefaultBlanketAgreementNumber": null,
"EffectiveDiscount": "dgrLowestDiscount",
"NoDiscounts": "tNO",
"EffectivePrice": "epDefaultPriority",
"EffectivePriceConsidersPriceBeforeDiscount": "tNO",
"GlobalLocationNumber": null,
"EDISenderID": null,
"EDIRecipientID": null,
"ResidenNumber": "rntSpanishFiscalID",
"RelationshipCode": null,
"RelationshipDateFrom": null,
"RelationshipDateTill": null,
"UnifiedFederalTaxID": null,
"AttachmentEntry": null,
"TypeOfOperation": null,
"EndorsableChecksFromBP": "tYES",
"AcceptsEndorsedChecks": "tNO",
"OwnerCode": null,
"BlockSendingMarketingContent": "tNO",
"AgentCode": null,
"PriceMode": null,
"EDocGenerationType": null,
"EDocStreet": null,
"EDocStreetNumber": null,
"EDocBuildingNumber": null,
"EDocZipCode": null,
"EDocCity": null,
"EDocCountry": null,
"EDocDistrict": null,
"EDocRepresentativeFirstName": null,
"EDocRepresentativeSurname": null,
"EDocRepresentativeCompany": null,
"EDocRepresentativeFiscalCode": null,
"EDocRepresentativeAdditionalId": null,
"EDocPECAddress": null,
"IPACodeForPA": null,
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:49",
"ExemptionMaxAmountValidationType": "emaIndividual",
"ECommerceMerchantID": null,
"UseBillToAddrToDetermineTax": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"DefaultTransporterEntry": 0,
"DefaultTransporterLineNumber": 0,
"FCERelevant": "tNO",
"FCEValidateBaseDelivery": "tNO",
"MainUsage": null,
"EBooksVATExemptionCause": null,
"LegalText": null,
"DataVersion": 1,
"ExchangeRateForIncomingPayment": "tYES",
"ExchangeRateForOutgoingPayment": "tYES",
"CertificateDetails": null,
"DefaultCurrency": null,
"EORINumber": null,
"FCEAsPaymentMeans": "tNO",
"U_Discount": 0,
"U_InterBranch": "N",
"ElectronicProtocols": [],
"BPAddresses": [
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_BillTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 0,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
},
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_ShipTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 1,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
}
],
"ContactEmployees": [
{
"CardCode": "C01305",
"Name": "Anmol Steps – Bijolia(EL)",
"Position": null,
"Address": null,
"Phone1": "9460351521",
"Phone2": null,
"MobilePhone": "9460351521",
"Fax": null,
"E_Mail": null,
"Pager": null,
"Remarks1": null,
"Remarks2": null,
"Password": null,
"InternalCode": 1325,
"PlaceOfBirth": "-1",
"DateOfBirth": null,
"Gender": "gt_Undefined",
"Profession": null,
"Title": null,
"CityOfBirth": null,
"Active": "tYES",
"FirstName": null,
"MiddleName": null,
"LastName": null,
"EmailGroupCode": null,
"BlockSendingMarketingContent": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:00",
"ConnectedAddressName": null,
"ConnectedAddressType": null,
"ForeignCountry": null,
"ContactEmployeeBlockSendingMarketingContents": []
}
],
"BPAccountReceivablePaybleCollection": [],
"BPPaymentMethods": [],
"BPWithholdingTaxCollection": [],
"BPPaymentDates": [],
"BPBranchAssignment": [
{
"BPCode": "C01305",
"BPLID": 2,
"DisabledForBP": "tNO"
},
{
"BPCode": "C01305",
"BPLID": 4,
"DisabledForBP": "tNO"
}
],
"BPBankAccounts": [],
"BPFiscalTaxIDCollection": [
{
"Address": "",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": "",
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": null,
"TaxId1": null,
"TaxId2": null,
"TaxId3": null,
"TaxId4": null,
"TaxId5": null,
"TaxId6": null,
"TaxId7": null,
"TaxId8": null,
"TaxId9": null,
"TaxId10": null,
"TaxId11": null,
"BPCode": "C01305",
"AddrType": "bo_BillTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
}
],
"DiscountGroups": [],
"BPIntrastatExtension": {},
"BPBlockSendingMarketingContents": [],
"BPCurrenciesCollection": []
}
}
Get Invoice
Retrieve all or some selected properties from an instance of Warehouses with the given id. | key: getInvoice
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Entry | The document entry number (DocEntry) that uniquely identifies the invoice. This is an integer value. | 12345 |
Get Item
Retrieve all or some selected properties from an instance of Items with the given id. | key: getItem
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Item Code | The unique code identifying the item in the inventory. | A00001 |
Get Order
Retrieve all or some selected properties from an instance of Orders with the given id. | key: getOrder
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Entry | The document entry number (DocEntry) that uniquely identifies the order. This is an integer value. | 123 |
Get Price List
Retrieve all or some selected properties from an instance of PriceLists with the given id. | key: getPriceList
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Price List Number | The unique number identifying the price list. This is an integer value. | 1 |
{
"data": {
"RoundingMethod": "borm_NoRounding",
"GroupNum": "boplgn_Group2",
"BasePriceList": 2,
"Factor": 1,
"PriceListNo": 2,
"PriceListName": "Buying Price List",
"IsGrossPrice": "tNO",
"Active": "tYES",
"ValidFrom": null,
"ValidTo": null,
"DefaultPrimeCurrency": "INR",
"DefaultAdditionalCurrency1": "INR",
"DefaultAdditionalCurrency2": "INR",
"RoundingRule": "borrRoundOff",
"FixedAmount": 0
}
}
Get Purchase Order
Retrieve all or some selected properties from an instance of Purchase Orders with the given id. | key: getPurchaseOrder
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Purchase Order Document Entry | The document entry number (DocEntry) that uniquely identifies the purchase order. This is an integer value. | 12345 |
Get Record
Retrieve a single record from SAP Business One. | key: getRecord
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Record ID | The unique identifier for the record. This is typically an integer value (DocEntry or similar). | 12345 |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
Get Warehouse
Retrieve all or some selected properties from an instance of Warehouses with the given id. | key: getWarehouse
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Warehouse Code | The unique code identifying the warehouse. | WH01 |
{
"data": {
"Street": null,
"StockInflationOffsetAccount": null,
"ZipCode": "110044",
"DecreasingAccount": null,
"PurchaseAccount": null,
"EURevenuesAccount": null,
"ReturningAccount": null,
"ShippedGoodsAccount": null,
"StockInflationAdjustAccount": null,
"AllowUseTax": "tNO",
"CostInflationAccount": null,
"ForeignExpensesAccount": null,
"EUExpensesAccount": null,
"CostInflationOffsetAccount": null,
"ExpensesClearingAccount": null,
"PurchaseReturningAccount": null,
"VATInRevenueAccount": null,
"FederalTaxID": null,
"Location": 3,
"Block": null,
"ExpenseAccount": null,
"DecreaseGLAccount": null,
"RevenuesAccount": null,
"TaxGroup": null,
"ExemptRevenuesAccount": null,
"PurchaseOffsetAccount": null,
"CostOfGoodsSold": null,
"WarehouseCode": "Del-02",
"State": "DL",
"City": "DELHI",
"PriceDifferencesAccount": null,
"VarianceAccount": null,
"Country": "IN",
"IncreaseGLAccount": null,
"ExchangeRateDifferencesAccount": null,
"WIPMaterialAccount": null,
"WarehouseName": "Badapur - Rejection warehouse",
"DropShip": "tNO",
"WIPMaterialVarianceAccount": null,
"TransfersAcc": null,
"InternalKey": null,
"ForeignRevenuesAcc": null,
"BuildingFloorRoom": null,
"County": null,
"Nettable": "tYES",
"IncreasingAcc": null,
"ExpenseOffsetingAct": null,
"GoodsClearingAcc": null,
"StockAccount": null,
"BusinessPlaceID": 2,
"PurchaseCreditAcc": null,
"EUPurchaseCreditAcc": null,
"ForeignPurchaseCreditAcc": null,
"SalesCreditAcc": null,
"SalesCreditEUAcc": null,
"ExemptedCredits": null,
"SalesCreditForeignAcc": null,
"NegativeInventoryAdjustmentAccount": null,
"WHShipToName": null,
"Excisable": "tNO",
"WHIncomingCenvatAccount": null,
"WHOutgoingCenvatAccount": null,
"StockInTransitAccount": null,
"WipOffsetProfitAndLossAccount": null,
"InventoryOffsetProfitAndLossAccount": null,
"AddressType": null,
"StreetNo": null,
"Storekeeper": null,
"Shipper": null,
"ManageSerialAndBatchNumbers": "tNO",
"GlobalLocationNumber": null,
"EnableBinLocations": "tNO",
"BinLocCodeSeparator": "-",
"DefaultBin": null,
"DefaultBinEnforced": "tNO",
"AutoAllocOnIssue": "whsBinSingleChoiceOnly",
"EnableReceivingBinLocations": "tNO",
"ReceivingBinLocationsBy": "rblmBinLocationCodeOrder",
"PurchaseBalanceAccount": null,
"Inactive": "tNO",
"RestrictReceiptToEmptyBinLocation": "tYES",
"ReceiveUpToMaxQuantity": "tNO",
"AutoAllocOnReceipt": "aaormDefaultBin",
"ReceiveUpToMaxWeight": "tNO",
"ReceiveUpToMethod": "rutmMaximumQty",
"LegalText": null
}
}
Get Warehouse Location
Retrieve all or some selected properties from an instance of Warehouse Location with the given id. | key: getWarehouseLocation
| Input | Notes | Example |
|---|---|---|
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Warehouse Location ID | The unique identifier for the warehouse location. This is an integer value. | 1 |
{
"data": {
"Code": 1,
"Name": "Delhi",
"LSTVATNumber": null,
"CSTNumber": "07AAFCE3317E1Z1",
"ExemptionNumber": null,
"TANNumber": null,
"ServiceTaxNumber": null,
"AssesseeType": null,
"CompanyType": null,
"NatureOfBusiness": null,
"TINNumber": null,
"RegistrationType": "XM",
"EccNumber": "AABPS8791RXM001",
"CERange": null,
"CEDivision": null,
"CECommissionerate": null,
"ManufacturerCode": null,
"Jurisdiction": null,
"Street": "B-2/3 , Second Floor, Mohan Co-Operative Industrial Estate",
"Block": "Mathura Road",
"ZipCode": "110044",
"City": "New Delhi",
"County": null,
"Country": "IN",
"State": "DL",
"PANNumber": "AABPS8791R",
"CERegisterNumber": null,
"BuildingFloorRoom": null,
"GSTIN": "07AAFCE3317E1Z1",
"GstType": "gstRegularTDSISD",
"GSTTDS": null,
"GSTISD": null,
"U_UTL_ST_OWID": "6daf01b8-77bc-467d-91e8-d00d1fc53d45",
"U_CID": null,
"U_SECRET": null,
"U_UTL_EUID": null,
"U_UTL_EPSW": null,
"U_UTL_ST_PAYUPID": null,
"U_UTL_ST_PAYNM": null,
"U_UTL_ST_PAYACNO": null,
"U_UTL_ST_PAYIFSC": null
}
}
List Business Partners
Retrieve a collection of Business Partners with all or some selected properties | key: listBusinessPartners
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
{
"data": [
{
"odata.etag": "W/\"356A192B7913B04C54574D18C28D46E6395428AB\"",
"CardCode": "C01305",
"CardName": "Anmol Steps – Bijolia(EL)",
"CardType": "cCustomer",
"GroupCode": 112,
"Address": "Bundi Road, Bijolia",
"ZipCode": "311602",
"MailAddress": "Bundi Road, Bijolia",
"MailZipCode": "311602",
"Phone1": "9460351521",
"Phone2": null,
"Fax": null,
"ContactPerson": "Anmol Steps – Bijolia(EL)",
"Notes": null,
"PayTermsGrpCode": 5,
"CreditLimit": 0,
"MaxCommitment": 0,
"DiscountPercent": 0,
"VatLiable": "vLiable",
"FederalTaxID": null,
"DeductibleAtSource": "tNO",
"DeductionPercent": 0,
"DeductionValidUntil": null,
"PriceListNum": 19,
"IntrestRatePercent": 0,
"CommissionPercent": 0,
"CommissionGroupCode": 0,
"FreeText": null,
"SalesPersonCode": -1,
"Currency": "INR",
"RateDiffAccount": "",
"Cellular": "9460351521",
"AvarageLate": null,
"City": "Bijolia",
"County": null,
"Country": "IN",
"MailCity": "Bijolia",
"MailCounty": null,
"MailCountry": "IN",
"EmailAddress": null,
"Picture": null,
"DefaultAccount": null,
"DefaultBranch": null,
"DefaultBankCode": "-1",
"AdditionalID": null,
"Pager": null,
"FatherCard": "C01169",
"CardForeignName": null,
"FatherType": "cDelivery_sum",
"DeductionOffice": null,
"ExportCode": null,
"MinIntrest": 0,
"CurrentAccountBalance": 0,
"OpenDeliveryNotesBalance": 0,
"OpenOrdersBalance": 0,
"OpenChecksBalance": 0,
"VatGroup": null,
"ShippingType": null,
"Password": null,
"Indicator": null,
"IBAN": null,
"CreditCardCode": -1,
"CreditCardNum": null,
"CreditCardExpiration": null,
"DebitorAccount": "_SYS00000000037",
"OpenOpportunities": null,
"Valid": "tYES",
"ValidFrom": null,
"ValidTo": null,
"ValidRemarks": null,
"Frozen": "tNO",
"FrozenFrom": null,
"FrozenTo": null,
"FrozenRemarks": null,
"Block": null,
"BillToState": "RJ",
"ShipToState": "RJ",
"ExemptNum": null,
"Priority": -1,
"FormCode1099": null,
"Box1099": null,
"PeymentMethodCode": null,
"BackOrder": "tYES",
"PartialDelivery": "tYES",
"BlockDunning": "tNO",
"BankCountry": null,
"HouseBank": null,
"HouseBankCountry": "IN",
"HouseBankAccount": null,
"ShipToDefault": "Anmol Steps – Bijolia(EL)",
"DunningLevel": null,
"DunningDate": null,
"CollectionAuthorization": "tNO",
"DME": null,
"InstructionKey": null,
"SinglePayment": "tNO",
"ISRBillerID": null,
"PaymentBlock": "tNO",
"ReferenceDetails": null,
"HouseBankBranch": null,
"OwnerIDNumber": null,
"PaymentBlockDescription": -1,
"TaxExemptionLetterNum": null,
"MaxAmountOfExemption": 0,
"ExemptionValidityDateFrom": null,
"ExemptionValidityDateTo": null,
"LinkedBusinessPartner": null,
"LastMultiReconciliationNum": null,
"DeferredTax": "tNO",
"Equalization": "tNO",
"SubjectToWithholdingTax": "boNO",
"CertificateNumber": null,
"ExpirationDate": null,
"NationalInsuranceNum": null,
"AccrualCriteria": "tNO",
"WTCode": null,
"BillToBuildingFloorRoom": "",
"DownPaymentClearAct": "_SYS00000000084",
"ChannelBP": null,
"DefaultTechnician": null,
"BilltoDefault": "Anmol Steps – Bijolia(EL)",
"CustomerBillofExchangDisc": null,
"Territory": null,
"ShipToBuildingFloorRoom": "",
"CustomerBillofExchangPres": null,
"ProjectCode": null,
"VatGroupLatinAmerica": null,
"DunningTerm": null,
"Website": null,
"OtherReceivablePayable": null,
"BillofExchangeonCollection": null,
"CompanyPrivate": "cCompany",
"LanguageCode": 8,
"UnpaidBillofExchange": null,
"WithholdingTaxDeductionGroup": -1,
"ClosingDateProcedureNumber": null,
"Profession": null,
"BankChargesAllocationCode": null,
"TaxRoundingRule": "trr_CompanyDefault",
"Properties1": "tNO",
"Properties2": "tNO",
"Properties3": "tNO",
"Properties4": "tNO",
"Properties5": "tNO",
"Properties6": "tNO",
"Properties7": "tNO",
"Properties8": "tNO",
"Properties9": "tNO",
"Properties10": "tNO",
"Properties11": "tNO",
"Properties12": "tNO",
"Properties13": "tNO",
"Properties14": "tNO",
"Properties15": "tNO",
"Properties16": "tNO",
"Properties17": "tNO",
"Properties18": "tNO",
"Properties19": "tNO",
"Properties20": "tNO",
"Properties21": "tNO",
"Properties22": "tNO",
"Properties23": "tNO",
"Properties24": "tNO",
"Properties25": "tNO",
"Properties26": "tNO",
"Properties27": "tNO",
"Properties28": "tNO",
"Properties29": "tNO",
"Properties30": "tNO",
"Properties31": "tNO",
"Properties32": "tNO",
"Properties33": "tNO",
"Properties34": "tNO",
"Properties35": "tNO",
"Properties36": "tNO",
"Properties37": "tNO",
"Properties38": "tNO",
"Properties39": "tNO",
"Properties40": "tNO",
"Properties41": "tNO",
"Properties42": "tNO",
"Properties43": "tNO",
"Properties44": "tNO",
"Properties45": "tNO",
"Properties46": "tNO",
"Properties47": "tNO",
"Properties48": "tNO",
"Properties49": "tNO",
"Properties50": "tNO",
"Properties51": "tNO",
"Properties52": "tNO",
"Properties53": "tNO",
"Properties54": "tNO",
"Properties55": "tNO",
"Properties56": "tNO",
"Properties57": "tNO",
"Properties58": "tNO",
"Properties59": "tNO",
"Properties60": "tNO",
"Properties61": "tNO",
"Properties62": "tNO",
"Properties63": "tNO",
"Properties64": "tNO",
"CompanyRegistrationNumber": null,
"VerificationNumber": null,
"DiscountBaseObject": "dgboNone",
"DiscountRelations": "dgrLowestDiscount",
"TypeReport": "atCompany",
"ThresholdOverlook": "tNO",
"SurchargeOverlook": "tNO",
"DownPaymentInterimAccount": "_SYS00000000054",
"OperationCode347": "ocSalesOrServicesRevenues",
"InsuranceOperation347": "tNO",
"HierarchicalDeduction": "tNO",
"ShaamGroup": "sgServicesAndAsset",
"WithholdingTaxCertified": "tNO",
"BookkeepingCertified": "tNO",
"PlanningGroup": null,
"Affiliate": "tNO",
"Industry": null,
"VatIDNum": null,
"DatevAccount": null,
"DatevFirstDataEntry": "tYES",
"UseShippedGoodsAccount": "tNO",
"GTSRegNo": null,
"GTSBankAccountNo": null,
"GTSBillingAddrTel": null,
"ETaxWebSite": null,
"HouseBankIBAN": "",
"VATRegistrationNumber": null,
"RepresentativeName": null,
"IndustryType": null,
"BusinessType": null,
"Series": 85,
"AutomaticPosting": null,
"InterestAccount": null,
"FeeAccount": null,
"CampaignNumber": null,
"AliasName": null,
"DefaultBlanketAgreementNumber": null,
"EffectiveDiscount": "dgrLowestDiscount",
"NoDiscounts": "tNO",
"EffectivePrice": "epDefaultPriority",
"EffectivePriceConsidersPriceBeforeDiscount": "tNO",
"GlobalLocationNumber": null,
"EDISenderID": null,
"EDIRecipientID": null,
"ResidenNumber": "rntSpanishFiscalID",
"RelationshipCode": null,
"RelationshipDateFrom": null,
"RelationshipDateTill": null,
"UnifiedFederalTaxID": null,
"AttachmentEntry": null,
"TypeOfOperation": null,
"EndorsableChecksFromBP": "tYES",
"AcceptsEndorsedChecks": "tNO",
"OwnerCode": null,
"BlockSendingMarketingContent": "tNO",
"AgentCode": null,
"PriceMode": null,
"EDocGenerationType": null,
"EDocStreet": null,
"EDocStreetNumber": null,
"EDocBuildingNumber": null,
"EDocZipCode": null,
"EDocCity": null,
"EDocCountry": null,
"EDocDistrict": null,
"EDocRepresentativeFirstName": null,
"EDocRepresentativeSurname": null,
"EDocRepresentativeCompany": null,
"EDocRepresentativeFiscalCode": null,
"EDocRepresentativeAdditionalId": null,
"EDocPECAddress": null,
"IPACodeForPA": null,
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:49",
"ExemptionMaxAmountValidationType": "emaIndividual",
"ECommerceMerchantID": null,
"UseBillToAddrToDetermineTax": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"DefaultTransporterEntry": 0,
"DefaultTransporterLineNumber": 0,
"FCERelevant": "tNO",
"FCEValidateBaseDelivery": "tNO",
"MainUsage": null,
"EBooksVATExemptionCause": null,
"LegalText": null,
"DataVersion": 1,
"ExchangeRateForIncomingPayment": "tYES",
"ExchangeRateForOutgoingPayment": "tYES",
"CertificateDetails": null,
"DefaultCurrency": null,
"EORINumber": null,
"FCEAsPaymentMeans": "tNO",
"U_Discount": 0,
"U_InterBranch": "N",
"ElectronicProtocols": [],
"BPAddresses": [
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_BillTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 0,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
},
{
"AddressName": "Anmol Steps – Bijolia(EL)",
"Street": "Bundi Road, Bijolia",
"Block": null,
"ZipCode": "311602",
"City": "Bijolia",
"County": null,
"Country": "IN",
"State": "RJ",
"FederalTaxID": null,
"TaxCode": null,
"BuildingFloorRoom": null,
"AddressType": "bo_ShipTo",
"AddressName2": null,
"AddressName3": null,
"TypeOfAddress": null,
"StreetNo": null,
"BPCode": "C01305",
"RowNum": 1,
"GlobalLocationNumber": null,
"Nationality": null,
"TaxOffice": null,
"GSTIN": null,
"GstType": null,
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"MYFType": null,
"TaasEnabled": "tYES",
"U_UTL_ST_ThLegName": null,
"U_UTL_ST_ThTrdName": null
}
],
"ContactEmployees": [
{
"CardCode": "C01305",
"Name": "Anmol Steps – Bijolia(EL)",
"Position": null,
"Address": null,
"Phone1": "9460351521",
"Phone2": null,
"MobilePhone": "9460351521",
"Fax": null,
"E_Mail": null,
"Pager": null,
"Remarks1": null,
"Remarks2": null,
"Password": null,
"InternalCode": 1325,
"PlaceOfBirth": "-1",
"DateOfBirth": null,
"Gender": "gt_Undefined",
"Profession": null,
"Title": null,
"CityOfBirth": null,
"Active": "tYES",
"FirstName": null,
"MiddleName": null,
"LastName": null,
"EmailGroupCode": null,
"BlockSendingMarketingContent": "tNO",
"CreateDate": "2023-10-26",
"CreateTime": "13:16:49",
"UpdateDate": "2023-10-26",
"UpdateTime": "13:16:00",
"ConnectedAddressName": null,
"ConnectedAddressType": null,
"ForeignCountry": null,
"ContactEmployeeBlockSendingMarketingContents": []
}
],
"BPAccountReceivablePaybleCollection": [],
"BPPaymentMethods": [],
"BPWithholdingTaxCollection": [],
"BPPaymentDates": [],
"BPBranchAssignment": [
{
"BPCode": "C01305",
"BPLID": 2,
"DisabledForBP": "tNO"
},
{
"BPCode": "C01305",
"BPLID": 4,
"DisabledForBP": "tNO"
}
],
"BPBankAccounts": [],
"BPFiscalTaxIDCollection": [
{
"Address": "",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": "",
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": null,
"TaxId1": null,
"TaxId2": null,
"TaxId3": null,
"TaxId4": null,
"TaxId5": null,
"TaxId6": null,
"TaxId7": null,
"TaxId8": null,
"TaxId9": null,
"TaxId10": null,
"TaxId11": null,
"BPCode": "C01305",
"AddrType": "bo_BillTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
},
{
"Address": "Anmol Steps – Bijolia(EL)",
"CNAECode": null,
"TaxId0": "ALKPM0323M",
"TaxId1": "",
"TaxId2": "",
"TaxId3": "",
"TaxId4": "",
"TaxId5": "",
"TaxId6": "",
"TaxId7": "",
"TaxId8": "",
"TaxId9": "",
"TaxId10": "",
"TaxId11": "",
"BPCode": "C01305",
"AddrType": "bo_ShipTo",
"TaxId12": null,
"TaxId13": null,
"AToRetrNFe": "tNO"
}
],
"DiscountGroups": [],
"BPIntrastatExtension": {},
"BPBlockSendingMarketingContents": [],
"BPCurrenciesCollection": []
}
]
}
List Invoices
Retrieve a collection of Invoices with all or some selected properties in the given order by specifying the given filter condition. | key: listInvoices
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
List Items
Retrieve a collection of Items with all or some selected properties. | key: listItems
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
List Orders
Retrieve a collection of Orders with all or some selected properties | key: listOrders
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
List Price Lists
Retrieve a collection of PriceLists with all or some selected properties. | key: listPriceLists
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
{
"data": [
{
"RoundingMethod": "borm_NoRounding",
"GroupNum": "boplgn_Group2",
"BasePriceList": 2,
"Factor": 1,
"PriceListNo": 2,
"PriceListName": "Buying Price List",
"IsGrossPrice": "tNO",
"Active": "tYES",
"ValidFrom": null,
"ValidTo": null,
"DefaultPrimeCurrency": "INR",
"DefaultAdditionalCurrency1": "INR",
"DefaultAdditionalCurrency2": "INR",
"RoundingRule": "borrRoundOff",
"FixedAmount": 0
}
]
}
List Purchase Orders
Retrieve a collection of Purchase Orders with all or some selected properties. | key: listPurchaseOrders
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
List Records
Retrieve a list of records from SAP Business One. | key: listRecords
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
List Warehouse Locations
Retrieve a collection of Warehouses Locations with all or some selected properties in the given order by specifying the given filter condition. | key: listWarehouseLocations
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
{
"data": [
{
"Code": 1,
"Name": "Delhi",
"LSTVATNumber": null,
"CSTNumber": "07AAFCE3317E1Z1",
"ExemptionNumber": null,
"TANNumber": null,
"ServiceTaxNumber": null,
"AssesseeType": null,
"CompanyType": null,
"NatureOfBusiness": null,
"TINNumber": null,
"RegistrationType": "XM",
"EccNumber": "AABPS8791RXM001",
"CERange": null,
"CEDivision": null,
"CECommissionerate": null,
"ManufacturerCode": null,
"Jurisdiction": null,
"Street": "B-2/3 , Second Floor, Mohan Co-Operative Industrial Estate",
"Block": "Mathura Road",
"ZipCode": "110044",
"City": "New Delhi",
"County": null,
"Country": "IN",
"State": "DL",
"PANNumber": "AABPS8791R",
"CERegisterNumber": null,
"BuildingFloorRoom": null,
"GSTIN": "07AAFCE3317E1Z1",
"GstType": "gstRegularTDSISD",
"GSTTDS": null,
"GSTISD": null,
"U_UTL_ST_OWID": "6daf01b8-77bc-467d-91e8-d00d1fc53d45",
"U_CID": null,
"U_SECRET": null,
"U_UTL_EUID": null,
"U_UTL_EPSW": null,
"U_UTL_ST_PAYUPID": null,
"U_UTL_ST_PAYNM": null,
"U_UTL_ST_PAYACNO": null,
"U_UTL_ST_PAYIFSC": null
}
]
}
List Warehouses
Retrieve a collection of Warehouses with all or some selected properties in the given order by specifying the given filter condition. | key: listWarehouses
| Input | Notes | Example |
|---|---|---|
| Filter | An OData filter expression to apply to the request (e.g., startswith, eq, gt). See OData $filter documentation for filter syntax. | startswith(ItemCode, 'A001') |
| Order By | A comma-separated list of fields to sort by. Add 'asc' or 'desc' after field name for sort direction (e.g., ItemCode desc). | ItemCode asc |
| Select | A comma-separated list of fields to include in the response. If not provided, all fields will be returned and the query may be slower. See OData $select documentation for available fields. | ItemCode,ItemName,ForeignName |
| Skip | The number of items to skip before returning results. Used for pagination. | 20 |
| Top | The maximum number of items to return. Maximum value is 20. | 10 |
| Connection | The SAP Business One connection to use. | |
| Custom Query Params | Custom query parameters to include in the request, such as $expand for related entities. | $expand=value |
| Debug Request | Enabling this flag will log out the current request. | false |
| Fetch All | When true, all records will be fetched automatically by paginating through results. When false, only the number of records specified in $top will be returned. | false |
{
"data": [
{
"Street": "B-2/3 , Second Floor, Mohan Co-Operative Industrial Estate",
"StockInflationOffsetAccount": "",
"ZipCode": "110044",
"DecreasingAccount": "",
"PurchaseAccount": "",
"EURevenuesAccount": "",
"ReturningAccount": "",
"ShippedGoodsAccount": "",
"StockInflationAdjustAccount": "",
"AllowUseTax": "tNO",
"CostInflationAccount": "",
"ForeignExpensesAccount": "",
"EUExpensesAccount": "",
"CostInflationOffsetAccount": "",
"ExpensesClearingAccount": "",
"PurchaseReturningAccount": "",
"VATInRevenueAccount": "",
"FederalTaxID": null,
"Location": 1,
"Block": "Mathura Road",
"ExpenseAccount": "",
"DecreaseGLAccount": "",
"RevenuesAccount": "",
"TaxGroup": null,
"ExemptRevenuesAccount": "",
"PurchaseOffsetAccount": "",
"CostOfGoodsSold": "",
"WarehouseCode": "01",
"State": "DL",
"City": "New Delhi",
"PriceDifferencesAccount": "",
"VarianceAccount": "",
"Country": "IN",
"IncreaseGLAccount": "",
"ExchangeRateDifferencesAccount": "",
"WIPMaterialAccount": "",
"WarehouseName": "General Warehouse",
"DropShip": "tNO",
"WIPMaterialVarianceAccount": "",
"TransfersAcc": "",
"InternalKey": 0,
"ForeignRevenuesAcc": "",
"BuildingFloorRoom": null,
"County": null,
"Nettable": "tYES",
"IncreasingAcc": "",
"ExpenseOffsetingAct": "",
"GoodsClearingAcc": "",
"StockAccount": "",
"BusinessPlaceID": 0,
"PurchaseCreditAcc": "",
"EUPurchaseCreditAcc": "",
"ForeignPurchaseCreditAcc": "",
"SalesCreditAcc": "",
"SalesCreditEUAcc": "",
"ExemptedCredits": "",
"SalesCreditForeignAcc": "",
"NegativeInventoryAdjustmentAccount": "",
"WHShipToName": null,
"Excisable": "tNO",
"WHIncomingCenvatAccount": "",
"WHOutgoingCenvatAccount": "",
"StockInTransitAccount": "",
"WipOffsetProfitAndLossAccount": "",
"InventoryOffsetProfitAndLossAccount": "",
"AddressType": null,
"StreetNo": null,
"Storekeeper": null,
"Shipper": null,
"ManageSerialAndBatchNumbers": "tNO",
"GlobalLocationNumber": null,
"EnableBinLocations": "tNO",
"BinLocCodeSeparator": "-",
"DefaultBin": null,
"DefaultBinEnforced": "tNO",
"AutoAllocOnIssue": "whsBinSingleChoiceOnly",
"EnableReceivingBinLocations": "tNO",
"ReceivingBinLocationsBy": "rblmBinLocationCodeOrder",
"PurchaseBalanceAccount": "",
"Inactive": "tNO",
"RestrictReceiptToEmptyBinLocation": "tYES",
"ReceiveUpToMaxQuantity": "tNO",
"AutoAllocOnReceipt": "aaormDefaultBin",
"ReceiveUpToMaxWeight": "tNO",
"ReceiveUpToMethod": "rutmMaximumQty",
"LegalText": null
},
{
"Street": null,
"StockInflationOffsetAccount": null,
"ZipCode": "110044",
"DecreasingAccount": null,
"PurchaseAccount": null,
"EURevenuesAccount": null,
"ReturningAccount": null,
"ShippedGoodsAccount": null,
"StockInflationAdjustAccount": null,
"AllowUseTax": "tNO",
"CostInflationAccount": null,
"ForeignExpensesAccount": null,
"EUExpensesAccount": null,
"CostInflationOffsetAccount": null,
"ExpensesClearingAccount": null,
"PurchaseReturningAccount": null,
"VATInRevenueAccount": null,
"FederalTaxID": null,
"Location": 3,
"Block": null,
"ExpenseAccount": null,
"DecreaseGLAccount": null,
"RevenuesAccount": null,
"TaxGroup": null,
"ExemptRevenuesAccount": null,
"PurchaseOffsetAccount": null,
"CostOfGoodsSold": null,
"WarehouseCode": "Del-02",
"State": "DL",
"City": "DELHI",
"PriceDifferencesAccount": null,
"VarianceAccount": null,
"Country": "IN",
"IncreaseGLAccount": null,
"ExchangeRateDifferencesAccount": null,
"WIPMaterialAccount": null,
"WarehouseName": "Badapur - Rejection warehouse",
"DropShip": "tNO",
"WIPMaterialVarianceAccount": null,
"TransfersAcc": null,
"InternalKey": null,
"ForeignRevenuesAcc": null,
"BuildingFloorRoom": null,
"County": null,
"Nettable": "tYES",
"IncreasingAcc": null,
"ExpenseOffsetingAct": null,
"GoodsClearingAcc": null,
"StockAccount": null,
"BusinessPlaceID": 2,
"PurchaseCreditAcc": null,
"EUPurchaseCreditAcc": null,
"ForeignPurchaseCreditAcc": null,
"SalesCreditAcc": null,
"SalesCreditEUAcc": null,
"ExemptedCredits": null,
"SalesCreditForeignAcc": null,
"NegativeInventoryAdjustmentAccount": null,
"WHShipToName": null,
"Excisable": "tNO",
"WHIncomingCenvatAccount": null,
"WHOutgoingCenvatAccount": null,
"StockInTransitAccount": null,
"WipOffsetProfitAndLossAccount": null,
"InventoryOffsetProfitAndLossAccount": null,
"AddressType": null,
"StreetNo": null,
"Storekeeper": null,
"Shipper": null,
"ManageSerialAndBatchNumbers": "tNO",
"GlobalLocationNumber": null,
"EnableBinLocations": "tNO",
"BinLocCodeSeparator": "-",
"DefaultBin": null,
"DefaultBinEnforced": "tNO",
"AutoAllocOnIssue": "whsBinSingleChoiceOnly",
"EnableReceivingBinLocations": "tNO",
"ReceivingBinLocationsBy": "rblmBinLocationCodeOrder",
"PurchaseBalanceAccount": null,
"Inactive": "tNO",
"RestrictReceiptToEmptyBinLocation": "tYES",
"ReceiveUpToMaxQuantity": "tNO",
"AutoAllocOnReceipt": "aaormDefaultBin",
"ReceiveUpToMaxWeight": "tNO",
"ReceiveUpToMethod": "rutmMaximumQty",
"LegalText": null
}
]
}
Raw Request
Send raw HTTP request to the SAP Business One API | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The SAP Business One connection to use. | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| Debug Request | When true, the request and response details will be logged for debugging purposes. | false |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | The API endpoint path only (e.g., Items, Orders, BusinessPartners). The base URL is automatically included based on your connection settings. For example, to access Items, enter 'Items' here and it will be appended to the base URL ( | Items |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
Update Business Partner
Update an instance of Business Partners | key: updateBusinessPartner
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Card Code | The unique code identifying the business partner (customer or supplier). | C20000 |
| Card Name | The name of the business partner (customer or supplier). | Acme Corporation |
| Card Type | The type of the business partner: Customer (cCustomer), Supplier (cSupplier), or Lead (cLid). | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Invoice
Update an instance of Invoices. | key: updateInvoice
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Comments | The comments to be added to the modified order. | new comments - modified by Service Layer |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Entry | The document entry number (DocEntry) that uniquely identifies the invoice. This is an integer value. | 12345 |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Item
Update an instance of Items | key: updateItem
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Item Code | The unique code identifying the item in the inventory. | A00001 |
| Item Name | The name of the item in the inventory. | Desktop Computer |
| Item Type | The type of the item: Items (itItems), Labor (itLabor), Travel (itTravel), or Fixed Assets (itFixedAssets). |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Order
Update an instance of Orders. | key: updateOrder
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Comments | The comments to be added to the modified order. | new comments - modified by Service Layer |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Doc Entry | The document entry number (DocEntry) that uniquely identifies the order. This is an integer value. | 123 |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Price List
Update an instance of Price Lists. | key: updatePriceList
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Price List Name | The name of the price list. | Retail Price List |
| Price List Number | The unique number identifying the price list. This is an integer value. | 1 |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Purchase Order
Update an instance of Purchase Orders. | key: updatePurchaseOrder
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Comments | The comments to be added to the modified order. | new comments - modified by Service Layer |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Purchase Order Document Entry | The document entry number (DocEntry) that uniquely identifies the purchase order. This is an integer value. | 12345 |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Record
Update an existing record in SAP Business One. | key: updateRecord
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Record ID | The unique identifier for the record. This is typically an integer value (DocEntry or similar). | 12345 |
| Record Type | The type of record to use for the operation (e.g., JournalEntries, Activities, BusinessPartners). This corresponds to the Service Layer entity name. | JournalEntries |
{
"data": "UPDATED SUCCESSFULLY"
}
Update Warehouse
Update an instance of Warehouses. | key: updateWarehouse
| Input | Notes | Example |
|---|---|---|
| Body Fields | Additional fields to include in the request body as a JSON object. These fields will be merged with the other input values. | |
| Connection | The SAP Business One connection to use. | |
| Debug Request | Enabling this flag will log out the current request. | false |
| Warehouse Location ID | The unique identifier for the warehouse location. This is an integer value. | 1 |
| Warehouse Code | The unique code identifying the warehouse. | WH01 |
| Warehouse Name | The name of the warehouse. | Main Distribution Center |
{
"data": "UPDATED SUCCESSFULLY"
}
Changelog
2026-01-26
Added API Version selection to connection settings, allowing you to choose between v1 (OData 3.0) or v2 (OData 4.0) APIs. v2 is recommended for new integrations to access the latest OData 4.0 features and improved performance, while v1 remains available to ensure existing integrations continue working without modification.