From 7ff6e6245c0997288a09e9460920ddaa3350de3c Mon Sep 17 00:00:00 2001 From: simonlabarere Date: Thu, 12 Jun 2025 14:51:06 +0100 Subject: [PATCH] CCM-7485: Billing reference doc update --- specification/schemas/components/Message.yaml | 2 ++ specification/schemas/requests/CreateMessage.yaml | 2 ++ specification/snippets/BillingReferenceSnippet.yaml | 3 +++ 3 files changed, 7 insertions(+) create mode 100644 specification/snippets/BillingReferenceSnippet.yaml diff --git a/specification/schemas/components/Message.yaml b/specification/schemas/components/Message.yaml index 5414b8fa5..432b7a3ed 100644 --- a/specification/schemas/components/Message.yaml +++ b/specification/schemas/components/Message.yaml @@ -7,6 +7,8 @@ properties: description: This reference needs to be unique per message within this batch. If there are duplicate values then a 400 exception will be thrown highlighting the values that have been duplicated. format: uuid example: 703b8008-545d-4a04-bb90-1f2946ce1575 + billingReference: + $ref: ../../snippets/BillingReferenceSnippet.yaml recipient: $ref: Recipient.yaml originator: diff --git a/specification/schemas/requests/CreateMessage.yaml b/specification/schemas/requests/CreateMessage.yaml index 3c724bc95..32cade016 100644 --- a/specification/schemas/requests/CreateMessage.yaml +++ b/specification/schemas/requests/CreateMessage.yaml @@ -31,6 +31,8 @@ properties: This value is used internally to de-duplicate messages. If you send the same value through multiple times only one of the requests will be actioned. example: da0b1495-c7cb-468c-9d81-07dee089d728 + billingReference: + $ref: ../../snippets/BillingReferenceSnippet.yaml recipient: $ref: ../components/Recipient.yaml originator: diff --git a/specification/snippets/BillingReferenceSnippet.yaml b/specification/snippets/BillingReferenceSnippet.yaml new file mode 100644 index 000000000..9af3f3f6d --- /dev/null +++ b/specification/snippets/BillingReferenceSnippet.yaml @@ -0,0 +1,3 @@ +type: string +description: Optional reference for billing purposes. Can be any string. +example: billing-ref-1 \ No newline at end of file