Web Service Payloads & REST API Examples

SOAP · Financials — Receivables

Create a credit memo and apply it to an invoice

CreditMemoService.createCreditMemo creates a standard Receivables credit memo. Crediting an existing invoice is done on the request itself: PreviousCustomerTransactionId points at the invoice's CUSTOMER_TRX_ID, and LinePercent / TaxPercent set how much of that invoice's lines and tax to credit (100 = full credit).

SOAP · CX / TCA — Trading Community

Create a party site (address) for an organization

mergeOrganization on the CDM Foundation Parties Organization Service adds a PartySite (an address, with one or more site uses) to an existing organization party in Trading Community Architecture. Mandatory elements: PartyId (the organization), LocationId (an existing HZ location), CreatedByModule (e.g. HZ_WS), and SiteUseType on each PartySiteUse (e.g. BILL_TO). Source: Oracle 'Create a Party Site' SOAP example.

SOAP · Financials — Customers

Create a customer (party + account + site + site use)

ReceivablesCustomerService.createCustomer is the ERP Cloud service that creates the whole customer structure in one call: the organization party, its customer account, an account site (from an existing PartySiteId or an inline address), and one or more site uses (BILL_TO, SHIP_TO). CreatedByModule (HZ_WS) is set at every level; OrigSystemReference carries your source-system key. Element names below follow the documented pattern — confirm exact names against Oracle's 'SOAP Web Services for Financials Cloud' and the A-Team customer-creation guide.

REST · Financials — Payables

Create a Payables invoice with a line

The Payables Invoices REST resource creates an invoice header and its lines in one call. Minimum useful body: InvoiceNumber, InvoiceAmount, InvoiceDate, InvoiceCurrency, BusinessUnit, Supplier, SupplierSite, plus an invoiceLines child array with LineNumber, LineAmount and a distribution combination or distribution set.

REST · Procurement — Suppliers

Create a supplier

The Suppliers REST resource creates a supplier (POZ_SUPPLIERS). Minimum body: Supplier (name), SupplierType and TaxOrganizationType. Sites, addresses, contacts and bank accounts are added as child resources or in follow-up calls.

REST · Supply Chain — Order Management

Create a sales order (Order Import)

The Order Import (Order Hub) REST resource creates a sales order in Order Management. Identify the order with SourceTransactionNumber / SourceTransactionSystem / SourceTransactionId, set the requesting business unit and buying party, and add a lines child array — each line needs its own SourceTransactionLineId and SourceTransactionScheduleId, a product, quantity and UOM.

REST · Financials — Receivables

Create an AR (Receivables) invoice

The Receivables Invoices REST resource creates a customer transaction (invoice) plus its lines. Set BusinessUnit, TransactionSource, TransactionType ('Invoice'), TransactionDate/AccountingDate, BillToCustomerNumber and currency; add a receivablesInvoiceLines child array with line description, quantity and unit price. Distinct from bulk AutoInvoice / FBDI.

REST · Financials — Receivables

Create an AR credit memo (REST)

The Receivables Credit Memos REST resource creates a credit memo transaction and its lines. It mirrors the invoice payload, uses a Credit Memo transaction type, and references the invoice being credited (e.g. CreditedTransactionNumber). Line amounts are negative. For the SOAP equivalent, see the CreditMemoService payload.