Jump to

• Request
• Response

Create a Note

post

/invoices/{invoiceGid}/notes

Request

Path Parameters

• invoiceGid(required): string
  Resource ID

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.notes"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.notes"
    }
}

Nested Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• enteredBy: string
  The name and domain of the person who entered notes about the invoice.
• invoiceNoteSeqNo: number (int64)
  The Invoice Note Sequence number specifies the order of notes on the invoice or bill.
• isSystemGenerated: boolean
  Indicates whether this is system generated or not.
• links: array links
  Read Only: true
• note: string
  The note(s) about the invoice.
• summary: string
  Summary.
• timestamp: timestamp
  The day, month, and year of the note on the invoice.

{
    "properties":{
        "invoiceNoteSeqNo":{
            "description":"The Invoice Note Sequence number specifies the order of notes on the invoice or bill.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"The day, month, and year of the note on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"Summary.",
            "type":"string"
        },
        "note":{
            "description":"The note(s) about the invoice.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates whether this is system generated or not.",
            "type":"boolean"
        },
        "enteredBy":{
            "description":"The name and domain of the person who entered notes about the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

The day, month, and year of the note on the invoice.

Match All

Show Source

• object dateTimeType

{
    "description":"The day, month, and year of the note on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• enteredBy: string
  The name and domain of the person who entered notes about the invoice.
• invoiceNoteSeqNo: number (int64)
  The Invoice Note Sequence number specifies the order of notes on the invoice or bill.
• isSystemGenerated: boolean
  Indicates whether this is system generated or not.
• links: array links
  Read Only: true
• note: string
  The note(s) about the invoice.
• summary: string
  Summary.
• timestamp: timestamp
  The day, month, and year of the note on the invoice.

{
    "properties":{
        "invoiceNoteSeqNo":{
            "description":"The Invoice Note Sequence number specifies the order of notes on the invoice or bill.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"The day, month, and year of the note on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"Summary.",
            "type":"string"
        },
        "note":{
            "description":"The note(s) about the invoice.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates whether this is system generated or not.",
            "type":"boolean"
        },
        "enteredBy":{
            "description":"The name and domain of the person who entered notes about the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

The day, month, and year of the note on the invoice.

Match All

Show Source

• object dateTimeType

{
    "description":"The day, month, and year of the note on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular
• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• enteredBy: string
  The name and domain of the person who entered notes about the invoice.
• invoiceNoteSeqNo: number (int64)
  The Invoice Note Sequence number specifies the order of notes on the invoice or bill.
• isSystemGenerated: boolean
  Indicates whether this is system generated or not.
• links: array links
  Read Only: true
• note: string
  The note(s) about the invoice.
• summary: string
  Summary.
• timestamp: timestamp
  The day, month, and year of the note on the invoice.

{
    "properties":{
        "invoiceNoteSeqNo":{
            "description":"The Invoice Note Sequence number specifies the order of notes on the invoice or bill.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"The day, month, and year of the note on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"Summary.",
            "type":"string"
        },
        "note":{
            "description":"The note(s) about the invoice.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates whether this is system generated or not.",
            "type":"boolean"
        },
        "enteredBy":{
            "description":"The name and domain of the person who entered notes about the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

The day, month, and year of the note on the invoice.

Match All

Show Source

• object dateTimeType

{
    "description":"The day, month, and year of the note on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top