API Reference
Centara eMessaging exposes a set of API pages for integrating with Business Central data. These are standard BC API pages accessible via OData v4.
Base URL:
{BC Base URL}/api/centara/v1.0/companies({companyId})/
All endpoints are read-only (GET) unless otherwise noted. All endpoints support change tracking unless otherwise noted.
Approval Entries
Endpoint: .../approvalEntries
Source: Approval Entry table
| Field | Caption |
|---|
systemId | SystemId (key) |
tableID | Table ID |
documentType | Document Type |
documentNo | Document No. |
sequenceNo | Sequence No. |
approvalCode | Approval Code |
senderID | Sender ID |
salespersPurchCode | Salespers./Purch. Code |
approverID | Approver ID |
status | Status |
dateTimeSentForApproval | Date-Time Sent for Approval |
lastDateTimeModified | Last Date-Time Modified |
lastModifiedByUserID | Last Modified By User ID |
comment | Comment |
dueDate | Approval Due Date |
amount | Amount |
amountLCY | Amount (LCY) |
currencyCode | Currency Code |
approvalType | Approval Type |
limitType | Limit Type |
availableCreditLimitLCY | Available Credit Limit (LCY) |
recordIDToApprove | Record ID to Approve |
delegationDateFormula | Delegation Date Formula |
entryNo | Entry No. |
workflowStepInstanceID | Workflow Step Instance ID |
relatedToChange | Related to Change |
rsmstaPurchaseDocumentType | Purchase Document Type |
rsmstaDocumentLineNo | Document Line |
rsmstaWorkflowUserGroupCode | Workflow User Group Code |
Certificate
Endpoint: .../certificates
Source: Temporary buffer. Supports POST (uploads a certificate).
| Field | Caption | Editable |
|---|
id | Id (key) | No |
extensionContent | Content (binary) | Yes |
certificateSubject | Certificate Subject | No (computed) |
certificateValidTo | Certificate Valid To | No (computed) |
POST a binary certificate to extensionContent. The certificateSubject and certificateValidTo fields are computed and returned after upload.
Endpoint: .../purchHeaderApprovals
Source: Purchase Header — filtered to Status = Pending Approval. Document types: Invoice, Order, Credit Memo.
| Field | Caption |
|---|
systemId | SystemId (key) |
documentType | Document Type |
no | No. |
amount | Amount |
amountIncludingVAT | Amount Including VAT |
vendorOrderNo | Vendor Order No. |
rsmstaEInvoiceVATTotal | eInvoice VAT Total |
rsmstaEInvoiceTotalAmt | eInvoice Total Amount |
rsmstaEInvLineAmtInclVAT | eInvoice Total Amount Including VAT |
rsmstaSecondApprover | Second Approver |
rsmstaOriginalApprovalUser | Original Approval User |
rsmstaOriginalApprovalUserGroup | Approval User Group |
rsmsta4EyesWorkflowUserGroup | Four Eyes Approval User Group |
rsmstaEDocumentStatus | Centara Outbound Document Status |
rsmstaInboundDocumentStatus | Centara Inbound Document Status |
rsmstaIdentifierInWC | Identifier in Centara |
rsmstaSentToCentaraOn | Sent to Centara On |
rsmstaGuid | Guid |
rsmstaRejectionCode | Rejection Code |
rsmstaFromInboundEDocument | From Inbound e-Document |
rsmstaIsOCRGenerated | Is OCR Generated |
Actions
| Action | Method | Purpose |
|---|
ApproveFirstApprover | POST | Approves the entry for the original approval user |
ApproveSecondApprover | POST | Approves the entry for the second approver |
Purchase Line Approval
Endpoint: .../purchLineApprovals
Source: Purchase Line — filtered to Approval Status = Pending Approval. Document types: Invoice, Order, Credit Memo.
| Field | Caption |
|---|
systemId | SystemId (key) |
documentType | Document Type |
no | No. |
amount | Amount |
amountIncludingVAT | Amount Including VAT |
rsmstaOriginalApprovalUser | Original Approval User |
rsmstaOriginalApprovalUserGroup | Approval User Group |
Actions
| Action | Method | Purpose |
|---|
ApproveFirstApprover | POST | Approves the open approval entry for the original approval user on this line |
Purchase Orders & Invoices
Endpoint: .../purchaseOrdersInvoices
Source: Purchase Header — document types: Order, Invoice.
| Field | Caption |
|---|
id | SystemId (key) |
rsmstaEInvoiceVATTotal | eInvoice VAT Total |
rsmstaEInvoiceTotalAmt | eInvoice Total Amount |
rsmstaEInvLineAmtInclVAT | eInvoice Total Amount Including VAT |
rsmstaSecondApprover | Second Approver |
rsmstaOriginalApprovalUser | Original Approval User |
rsmstaOriginalApprovalUserGroup | Approval User Group |
rsmsta4EyesWorkflowUserGroup | Four Eyes Approval User Group |
rsmstaEDocumentStatus | Centara Outbound Document Status |
rsmstaInboundDocumentStatus | Centara Inbound Document Status |
rsmstaIdentifierInWC | Identifier in Centara |
rsmstaSentToCentaraOn | Sent to Centara On |
rsmstaGuid | Guid |
rsmstaRejectionCode | Rejection Code |
rsmstaFromInboundEDocument | From Inbound e-Document |
rsmstaIsOCRGenerated | Is OCR Generated |
Purchase Order & Invoice Lines
Endpoint: .../purchaseOrderInvoiceLines
Source: Purchase Line — document types: Order, Invoice.
| Field | Caption |
|---|
systemId | SystemId (key) |
rsmstaLineGuid | Line Guid |
rsmstaOriginalApprovalUser | Original Approval User |
rsmstaApprovalStatus | Approval Status |
rsmstaRejectionCode | Rejection Code |
rsmstaUoMBeforeBaseUoM | Unit Code before Base UoM |
rsmstaOriginalApprovalUserGroup | Approval User Group |
Sales Orders
Endpoint: .../salesOrders
Source: Sales Header — document type: Order only. This page exposes the full Sales Header including all standard BC fields plus Centara-specific fields.
Key fields
| Field | Caption |
|---|
id | SystemId (key) |
no | No. |
documentType | Document Type |
status | Status |
Sell-to
| Field | Caption |
|---|
sellToCustomerNo | Sell-to Customer No. |
sellToCustomerName | Sell-to Customer Name |
sellToAddress | Sell-to Address |
sellToCity | Sell-to City |
sellToPostCode | Sell-to Post Code |
sellToCountryRegionCode | Sell-to Country/Region Code |
sellToEMail | Email |
sellToPhoneNo | Sell-to Phone No. |
Bill-to
| Field | Caption |
|---|
billToCustomerNo | Bill-to Customer No. |
billToName | Bill-to Name |
billToAddress | Bill-to Address |
billToCity | Bill-to City |
billToPostCode | Bill-to Post Code |
billToCountryRegionCode | Bill-to Country/Region Code |
Ship-to
| Field | Caption |
|---|
shipToCode | Ship-to Code |
shipToName | Ship-to Name |
shipToAddress | Ship-to Address |
shipToCity | Ship-to City |
shipToPostCode | Ship-to Post Code |
shipToCountryRegionCode | Ship-to Country/Region Code |
shipToPhoneNo | Ship-to Phone No. |
Dates
| Field | Caption |
|---|
orderDate | Order Date |
postingDate | Posting Date |
shipmentDate | Shipment Date |
documentDate | Document Date |
requestedDeliveryDate | Requested Delivery Date |
promisedDeliveryDate | Promised Delivery Date |
lastShipmentDate | Last Shipment Date |
Payment
| Field | Caption |
|---|
dueDate | Due Date |
paymentTermsCode | Payment Terms Code |
paymentDiscount | Payment Discount |
pmtDiscountDate | Pmt. Discount Date |
paymentMethodCode | Payment Method Code |
Totals & currency
| Field | Caption |
|---|
amount | Amount |
amountIncludingVAT | Amount Including VAT |
currencyCode | Currency Code |
currencyFactor | Currency Factor |
References
| Field | Caption |
|---|
externalDocumentNo | External Document No. |
yourReference | Your Reference |
Logistics
| Field | Caption |
|---|
locationCode | Location Code |
shipmentMethodCode | Shipment Method Code |
shippingAgentCode | Shipping Agent Code |
shippingAgentServiceCode | Shipping Agent Service Code |
completelyShipped | Completely Shipped |
shipped | Shipped |
shippedNotInvoiced | Shipped Not Invoiced |
VAT
| Field | Caption |
|---|
vatRegistrationNo | VAT Registration No. |
vatBusPostingGroup | VAT Bus. Posting Group |
vatReportingDate | VAT Reporting Date |
Dimensions
| Field | Caption |
|---|
shortcutDimension1Code | Shortcut Dimension 1 Code |
shortcutDimension2Code | Shortcut Dimension 2 Code |
dimensionSetID | Dimension Set ID |
Centara fields
| Field | Caption |
|---|
rsmstaEInvoiceVATTotal | eInvoice VAT Total |
rsmstaEInvoiceTotalAmt | eInvoice Total Amount |
rsmstaEInvLineAmtInclVAT | eInvoice Total Amount Including VAT |
rsmstaGuid | Guid |
rsmstaUpdatedGuid | Updated Guid |
rsmstaLinesRecreatedOn | Lines Recreated On |
rsmstaFromInboundEDocument | From Inbound e-Document |
Job queue
| Field | Caption |
|---|
jobQueueStatus | Job Queue Status |
jobQueueEntryID | Job Queue Entry ID |