POST /journal-records

Creates a journal record.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
estimatedAmount Number No

Amount of revenue estimated to be recognized at the schedule date. This value is ignored when updating a journal record with a type of automated.

_embedded Object No

Embedded objects that are requested by the expand query parameter.

_embedded.customer Object No
_embedded.invoice Object No
_embedded.debitAccount Object No
_embedded.journalEntry Object No
_embedded.invoiceItem Object No
_embedded.creditAccount Object No
invoiceItemId String Yes

ID of the invoice item.

createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

debitAccountId String Yes

ID of the debit journal account.

journalEntryId String Yes

ID of the journal entry.

customerId String No

ID of the customer.

invoiceId String No

ID of the invoice.

id String No

Unique resource ID.

creditAccountId String Yes

ID of the credit journal account.

_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "debitAccount"
  • "invoiceItem"
  • "journalEntry"
  • "creditAccount"
  • "self"
  • "customer"
  • "invoice"
updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

type String No

Valid values:

  • "manual"
  • "automated"
recognizedAmount Number No

Amount of revenue recognized at the journal period end.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.