Create Ledger Entry

POST {{baseUrl}}/ledger-entries

Create a Ledger Entry

Request Body

{"data"=>{"ledgerEntries"=>[{"buyer"=>{"externalBuyerId"=>"795fce4a-f13e-450d-a384-718577e1cde4"}, "seller"=>{"externalSellerId"=>"8f4a3a95-5cd5-4b70-8c25-0a0c7ef9e1e9"}, "customerRole"=>"Seller", "documentType"=>"Invoice", "externalLedgerEntryId"=>"c9c75d82-4572-438d-9a67-a8461b199a50", "documentNumber"=>"INV001", "documentStatus"=>{"value"=>"Delivered"}, "documentDate"=>"2022-07-26", "documentUploadDate"=>"2022-07-26", "documentUpdatedDateTime"=>"2022-07-26T09:00:00Z", "documentCreatedDateTime"=>"2022-07-26T09:00:00Z", "documentDueDate"=>"2022-08-26", "forecastPayDate"=>"2022-08-26", "originalAmount"=>{"currency"=>"USD", "amount"=>"10000.00"}, "netAmount"=>{"currency"=>"USD", "amount"=>"9000.00"}, "goodsDescription"=>"10,000 widgets", "fundedStatus"=>{"value"=>"None"}, "payments"=>[{"type"=>"Buyer", "paymentAmount"=>{"currency"=>"USD", "amount"=>"5000.00"}, "paidDate"=>"2022-08-26", "paymentCreatedDateTime"=>"2022-08-26T09:00:00Z"}, {"type"=>"Buyer", "paymentAmount"=>{"currency"=>"USD", "amount"=>"4000.00"}, "paidDate"=>"2022-08-20", "paymentCreatedDateTime"=>"2022-08-20T09:00:00Z"}], "context"=>"OnboardingAssessment"}, {"buyer"=>{"externalBuyerId"=>"795fce4a-f13e-450d-a384-718577e1cde4"}, "seller"=>{"externalSellerId"=>"8f4a3a95-5cd5-4b70-8c25-0a0c7ef9e1e9"}, "customerRole"=>"Seller", "documentType"=>"Invoice", "externalLedgerEntryId"=>"c5aaf566-bcd2-4d7e-ba16-55a76510ddc2", "documentNumber"=>"INV001", "documentStatus"=>{"value"=>"Delivered"}, "documentDate"=>"2022-07-26", "documentUploadDate"=>"2022-07-26", "documentUpdatedDateTime"=>"2022-07-26T09:00:00Z", "documentCreatedDateTime"=>"2022-07-26T09:00:00Z", "documentDueDate"=>"2022-08-26", "forecastPayDate"=>"2022-08-26", "originalAmount"=>{"currency"=>"USD", "amount"=>"10000.00"}, "netAmount"=>{"currency"=>"USD", "amount"=>"7000.00"}, "goodsDescription"=>"8,000 widgets", "fundedStatus"=>{"value"=>"None"}, "payments"=>[{"type"=>"Buyer", "paymentAmount"=>{"currency"=>"USD", "amount"=>"5000.00"}, "paidDate"=>"2022-08-26", "paymentCreatedDateTime"=>"2022-08-26T09:00:00Z"}, {"type"=>"Buyer", "paymentAmount"=>{"currency"=>"USD", "amount"=>"4000.00"}, "paidDate"=>"2022-08-20", "paymentCreatedDateTime"=>"2022-08-20T09:00:00Z"}], "context"=>"OnboardingAssessment"}]}}

HEADERS

Key	Datatype	Description
`Authorization`	string	Authorization Header
`X-HSBC-Request-Correlation-Id`	string	(Required) Correlation Id
`X-HSBC-Request-Idempotency-Key`	string	(Required) Idempotency Key
`X-HSBC-CountryCode`	string	(Required) ISO Country Code
`X-HSBC-PROFILEID`	string	(Required) Partner Profile Id
`Obo-Profile-Id`	string	(Required) Customer Profile Id
`X-HSBC-E2E-Trust-Token`	string	(Required)
`Content-Type`	string
`Accept`	string

RESPONSES

status: Created

{&quot;data&quot;:{&quot;ledgerEntries&quot;:[{&quot;ledgerEntryId&quot;:&quot;8657df64-16c9-11ed-861d-0242ac120002&quot;,&quot;buyer&quot;:{&quot;externalBuyerId&quot;:&quot;795fce4a-f13e-450d-a384-718577e1cde4&quot;},&quot;seller&quot;:{&quot;externalSellerId&quot;:&quot;8f4a3a95-5cd5-4b70-8c25-0a0c7ef9e1e9&quot;},&quot;customerRole&quot;:&quot;Seller&quot;,&quot;documentType&quot;:&quot;Invoice&quot;,&quot;externalLedgerEntryId&quot;:&quot;c9c75d82-4572-438d-9a67-a8461b199a50&quot;,&quot;documentNumber&quot;:&quot;INV001&quot;,&quot;documentStatus&quot;:{&quot;value&quot;:&quot;Delivered&quot;},&quot;documentDate&quot;:&quot;2022-07-26&quot;,&quot;documentUploadDate&quot;:&quot;2022-07-26&quot;,&quot;documentUpdatedDateTime&quot;:&quot;2022-07-26T09:00:00Z&quot;,&quot;documentCreatedDateTime&quot;:&quot;2022-07-26T09:00:00Z&quot;,&quot;documentDueDate&quot;:&quot;2022-08-26&quot;,&quot;forecastPayDate&quot;:&quot;2022-08-26&quot;,&quot;originalAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;10000.00&quot;},&quot;netAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;9000.00&quot;},&quot;goodsDescription&quot;:&quot;10,000 widgets&quot;,&quot;fundedStatus&quot;:{&quot;value&quot;:&quot;None&quot;},&quot;payments&quot;:[{&quot;type&quot;:&quot;Buyer&quot;,&quot;paymentAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;5000.00&quot;},&quot;paidDate&quot;:&quot;2022-08-26&quot;,&quot;paymentCreatedDateTime&quot;:&quot;2022-08-26T09:00:00Z&quot;},{&quot;type&quot;:&quot;Buyer&quot;,&quot;paymentAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;4000.00&quot;},&quot;paidDate&quot;:&quot;2022-08-20&quot;,&quot;paymentCreatedDateTime&quot;:&quot;2022-08-20T09:00:00Z&quot;}],&quot;context&quot;:&quot;OnboardingAssessment&quot;},{&quot;buyer&quot;:{&quot;externalBuyerId&quot;:&quot;795fce4a-f13e-450d-a384-718577e1cde4&quot;},&quot;seller&quot;:{&quot;externalSellerId&quot;:&quot;8f4a3a95-5cd5-4b70-8c25-0a0c7ef9e1e9&quot;},&quot;customerRole&quot;:&quot;Seller&quot;,&quot;documentType&quot;:&quot;Invoice&quot;,&quot;externalLedgerEntryId&quot;:&quot;c5aaf566-bcd2-4d7e-ba16-55a76510ddc2&quot;,&quot;documentNumber&quot;:&quot;INV002&quot;,&quot;documentStatus&quot;:{&quot;value&quot;:&quot;Delivered&quot;},&quot;documentDate&quot;:&quot;2022-08-26&quot;,&quot;documentUploadDate&quot;:&quot;2022-08-26&quot;,&quot;documentCreatedDateTime&quot;:&quot;2022-08-26T09:00:00Z&quot;,&quot;documentUpdatedDateTime&quot;:&quot;2022-08-26T09:00:00Z&quot;,&quot;documentDueDate&quot;:&quot;2022-09-26&quot;,&quot;forecastPayDate&quot;:&quot;2022-09-26&quot;,&quot;originalAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;8000.00&quot;},&quot;netAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;7000.00&quot;},&quot;goodsDescription&quot;:&quot;8,000 widgets&quot;,&quot;fundedStatus&quot;:{&quot;value&quot;:&quot;None&quot;},&quot;payments&quot;:[{&quot;type&quot;:&quot;Buyer&quot;,&quot;paymentAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;5000.00&quot;},&quot;paidDate&quot;:&quot;2022-08-26&quot;,&quot;paymentCreatedDateTime&quot;:&quot;2022-08-26T09:00:00Z&quot;},{&quot;type&quot;:&quot;Buyer&quot;,&quot;paymentAmount&quot;:{&quot;currency&quot;:&quot;USD&quot;,&quot;amount&quot;:&quot;4000.00&quot;},&quot;paidDate&quot;:&quot;2022-08-20&quot;,&quot;paymentCreatedDateTime&quot;:&quot;2022-08-20T09:00:00Z&quot;}],&quot;context&quot;:&quot;OnboardingAssessment&quot;}]},&quot;meta&quot;:{&quot;totalItems&quot;:2},&quot;links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;/ledger-entries&quot;}}}