# Get Credit Memo

## GET /public/v1/billing/credit-memos/{id}

>

OpenAPI:

```json
{"openapi":"3.0.1","info":{"title":"Marketplace API","version":"prod-4.0.104-g76805994"},"servers":[{"url":"https://api.platform.softwareone.com"}],"paths":{"/public/v1/billing/credit-memos/{id}":{"get":{"tags":["CreditMemos"],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"select","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"$meta":{"allOf":[{"type":"object","properties":{"omitted":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}],"description":"Platform entity metadata.","nullable":true},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"icon":{"type":"string","nullable":true}},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event for the creation of an entity."}],"description":"Contains details about the creation event of the entity."},"updated":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event for the update of an entity."}],"description":"Contains details about the most recent update event of the entity, if applicable.","nullable":true},"issued":{"allOf":[{"type":"object","properties":{"at":{"type":"string","description":"Indicates the date and time when the event occurred.","format":"date-time","nullable":true},"by":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/audit/allOf/0/properties/created/allOf/0/properties/by/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents an audit event when the credit memo reached the \"Issued\" status."}],"description":"Contains details about the most recent event when the credit memo reached the \"Issued\" status.","nullable":true}},"additionalProperties":false,"description":"Represents a container for audit-related events for a credit memo"}],"description":"Contains audit-related details for the entity."},"id":{"type":"string","description":"The unique identifier of the credit memo."},"agreement":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"status":{"allOf":[{"enum":["New","Draft","Provisioning","Updating","Active","Terminated","Failed","Deleted"],"type":"string"}]},"name":{"type":"string"}},"additionalProperties":false}]},"buyer":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false}]},"client":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"type":{"allOf":[{"enum":["Client","Vendor","Operations"],"type":"string"}],"nullable":true},"status":{"allOf":[{"enum":["Active","Enabled","Disabled"],"type":"string"}],"nullable":true},"name":{"type":"string","nullable":true}},"additionalProperties":false}]},"erpData":{"allOf":[{"type":"object","properties":{"addresses":{"allOf":[{"type":"object","properties":{"billTo":{"allOf":[{"type":"object","properties":{"name":{"type":"string","description":"The primary name associated with the address."},"name2":{"type":"string","description":"The secondary name associated with the address.","nullable":true},"email":{"type":"string","description":"The email associated with the address.","nullable":true},"customerNo":{"type":"string","description":"The customer number associated with the address.","nullable":true},"addressLine1":{"type":"string","description":"The first line of the address."},"addressLine2":{"type":"string","description":"The second line of the address.","nullable":true},"addressLine3":{"type":"string","description":"The third line of the address.","nullable":true},"city":{"type":"string","description":"The city of the address.","nullable":true},"postCode":{"type":"string","description":"The postal code of the address.","nullable":true},"county":{"type":"string","description":"The county/state/region of the address.","nullable":true},"country":{"type":"string","description":"The country of the address.","nullable":true},"contactName":{"type":"string","description":"The contact name associated with the address.","nullable":true},"contactNo":{"type":"string","description":"The contact number associated with the address.","nullable":true},"contactEmail":{"type":"string","description":"The contact email associated with the address.","nullable":true},"contactPhone":{"type":"string","description":"The contact phone number associated with the address.","nullable":true},"code":{"type":"string","description":"The code associated with the address.","nullable":true}},"additionalProperties":false,"description":"Represents an address with various details such as name, address lines, city, postcode, country, and contact name."}],"description":"The bill to address."},"licenseTo":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/erpData/allOf/0/properties/addresses/allOf/0/properties/billTo/allOf/0/properties"},"additionalProperties":false,"description":"Represents an address with various details such as name, address lines, city, postcode, country, and contact name."}],"description":"The license to address.","nullable":true},"sellTo":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/erpData/allOf/0/properties/addresses/allOf/0/properties/billTo/allOf/0/properties"},"additionalProperties":false,"description":"Represents an address with various details such as name, address lines, city, postcode, country, and contact name."}],"description":"The sell to address.","nullable":true},"shipTo":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/erpData/allOf/0/properties/addresses/allOf/0/properties/billTo/allOf/0/properties"},"additionalProperties":false,"description":"Represents an address with various details such as name, address lines, city, postcode, country, and contact name."}],"description":"The ship to address.","nullable":true}},"additionalProperties":false,"description":"Represents a list of addresses for billing purposes."}],"description":"The list of addresses associated with the credit memo."},"appliesToDocNo":{"type":"string","description":"The document number to which this credit memo applies.","nullable":true},"currencyCode":{"type":"string","description":"The currency code of the credit memo.","nullable":true},"documentDate":{"type":"string","description":"The document date of the credit memo.","format":"date-time","nullable":true},"documentNo":{"type":"string","description":"The document number of the credit memo."},"externalDocumentNo":{"type":"string","description":"The external document number of the credit memo.","nullable":true},"externalDocumentNo2":{"type":"string","description":"The second external document number of the credit memo.","nullable":true},"insideSalesCode":{"type":"string","description":"The inside sales code associated with the credit memo.","nullable":true},"navisionCountryCode":{"type":"string","description":"The Navision country code of the credit memo."},"postingDate":{"type":"string","description":"The posting date of the credit memo.","format":"date-time"},"rowVersion":{"type":"integer","description":"The row version of the credit memo, used for concurrency control.","format":"int64","nullable":true},"responsibilityCenterCode":{"type":"string","description":"The responsibility center code of the credit memo.","nullable":true},"salesPersonCode":{"type":"string","description":"The sales person code of the credit memo.","nullable":true},"shipmentMethodCode":{"type":"string","description":"The shipment method code of the credit memo.","nullable":true},"vatRegistrationNo":{"type":"string","description":"The VAT registration number of the credit memo.","nullable":true},"yourReference":{"type":"string","description":"The reference provided by the customer.","nullable":true}},"additionalProperties":false,"description":"Represents ERP-specific data related to a credit memo."}],"description":"ERP-specific data related to the credit memo."},"licensee":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true}},"additionalProperties":false}]},"lines":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the credit memo line."},"description":{"type":"string","description":"The description of the credit memo line.","nullable":true},"description2":{"type":"string","description":"The secondary description (aka additional info) of the credit memo line.","nullable":true},"documentNo":{"type":"string","description":"The document number associated with the credit memo line."},"erpData":{"allOf":[{"type":"object","properties":{"contractNo":{"type":"string","description":"The contract number associated with the credit memo line.","nullable":true},"countryOfUsage":{"type":"string","description":"The country of usage for the credit memo line.","nullable":true},"dataOrigin":{"type":"integer","description":"The data origin for the credit memo line.","format":"int32","nullable":true},"externalPositionNo":{"type":"string","description":"The external position number for the credit memo line.","nullable":true},"navisionCountryCode":{"type":"string","description":"The Navision country code for the credit memo line."},"parentItemNo":{"type":"string","description":"The parent item number for the credit memo line.","nullable":true},"primary":{"allOf":[{"type":"object","properties":{"identifier":{"type":"string","description":"The unique identifier for the ERP code."},"value":{"type":"string","description":"The value of the ERP code.","nullable":true},"version":{"type":"string","description":"The version of the ERP code.","nullable":true}},"additionalProperties":false,"description":"Represents ERP-specific data related to a credit memo line or invoice line."}],"description":"The primary code details for the credit memo line, if any."},"secondary":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/lines/items/properties/erpData/allOf/0/properties/primary/allOf/0/properties"},"additionalProperties":false,"description":"Represents ERP-specific data related to a credit memo line or invoice line."}],"description":"The secondary code details for the credit memo line, if any."},"rowVersion":{"type":"integer","description":"The row version of the credit memo line, for concurrency control.","format":"int64","nullable":true},"responsibilityCenterCode":{"type":"string","description":"The responsibility center code for the credit memo line.","nullable":true},"swoPurchaseOrderNo":{"type":"string","description":"The SWO purchase order number for the credit memo line.","nullable":true},"type":{"type":"integer","description":"The type of the credit memo line.","format":"int32","nullable":true},"unitOfMeasure":{"type":"string","description":"The unit of measure for the credit memo line.","nullable":true},"varAgreementNo":{"type":"string","description":"The VAR agreement number for the credit memo line.","nullable":true},"varPartnerNo":{"type":"string","description":"The VAR partner number for the credit memo line.","nullable":true}},"additionalProperties":false,"description":"Represents ERP-specific data related to a credit memo line."}],"description":"The ERP-specific data related to the credit memo line."},"itemNo":{"type":"string","description":"The item number for the credit memo line.","nullable":true},"lineNo":{"type":"integer","description":"The line number for the credit memo line.","format":"int32"},"period":{"allOf":[{"type":"object","properties":{"start":{"type":"string","description":"The start date and time of the period.","format":"date-time"},"end":{"type":"string","description":"The end date and time of the period.","format":"date-time"}},"additionalProperties":false,"description":"Represents the period during which a charge is applicable."}],"description":"The period associated with the credit memo line.","nullable":true},"price":{"allOf":[{"type":"object","properties":{"amount":{"type":"number","description":"The amount for the credit memo line, visible to clients or operations.","format":"double","nullable":true},"amountIncludingVat":{"type":"number","description":"The amount including VAT for the credit memo line, visible to clients or operations.","format":"double","nullable":true},"discountAmount":{"type":"number","description":"The discount amount for the credit memo line, visible to clients or operations.","format":"double","nullable":true},"invoiceDiscountAmount":{"type":"number","description":"The invoice discount amount for the credit memo line, visible to clients or operations.","format":"double","nullable":true},"lineAmount":{"type":"number","description":"The line amount for the credit memo line, visible to clients or operations.","format":"double","nullable":true},"purchaseCurrencyCode":{"type":"string","description":"The currency used for the purchase price, visible only to operations.","nullable":true},"purchaseCurrencyFactor":{"type":"number","description":"The factor applied to the purchase currency, visible only to operations.","format":"double","nullable":true},"purchasePrice":{"type":"number","description":"The purchase price for the credit memo line, visible only to operations.","format":"double"},"purchasePriceLcy":{"type":"number","description":"The purchase price in local currency for the credit memo line, visible only to operations.","format":"double"},"purchasePriceTotal":{"type":"number","description":"The total purchase price for the credit memo line, visible only to operations.","format":"double"},"purchasePriceTotalLcy":{"type":"number","description":"The total purchase price in local currency for the credit memo line, visible only to operations.","format":"double"},"quantity":{"type":"integer","description":"The quantity for the credit memo line.","format":"int32"},"salesMarkup":{"type":"number","description":"The sales markup for the credit memo line, visible only to operations.","format":"double","nullable":true},"salesMargin":{"type":"number","description":"The sales margin for the credit memo line, visible only to operations.","format":"double","nullable":true},"unitPrice":{"type":"number","description":"The unit price for the credit memo line.","format":"double","nullable":true},"vatBaseAmount":{"type":"number","description":"The VAT base amount for the credit memo line.","format":"double"},"vatCalculationType":{"type":"integer","description":"The VAT calculation type for the credit memo line.","format":"int32","nullable":true},"vatPercent":{"type":"number","description":"The VAT percentage for the credit memo line.","format":"double","nullable":true}},"additionalProperties":false,"description":"Represents the price details of a credit memo line."}],"description":"The price details for the credit memo line.","nullable":true}},"additionalProperties":false,"description":"Represents a line item in a credit memo, containing details such as amounts, descriptions, and identifiers."},"description":"The list of credit memo lines associated with the credit memo."},"price":{"allOf":[{"type":"object","properties":{"currency":{"type":"string","description":"The currency of the credit memo."},"currencyFactor":{"type":"number","description":"The factor applied to the currency, used for conversion or adjustments.","format":"double","nullable":true},"currencyFactor2":{"type":"number","description":"The second factor applied to the currency, used for conversion or adjustments.","format":"double","nullable":true},"margin":{"type":"number","description":"The margin value of the credit memo, visible to operations.","format":"double","nullable":true},"markup":{"type":"number","description":"The markup value of the credit memo, visible to operations.","format":"double","nullable":true},"totalPP":{"type":"number","description":"The total purchase price (PP) of the credit memo, visible to operations.","format":"double","nullable":true},"totalSP":{"type":"number","description":"The total selling price (SP) of the credit memo, visible to clients or operations.","format":"double","nullable":true},"totalST":{"type":"number","description":"The total sales tax (ST) of the credit memo, visible to clients or operations.","format":"double","nullable":true},"totalGT":{"type":"number","description":"The total gross amount (GT) of the credit memo, visible to clients or operations.","format":"double","nullable":true}},"additionalProperties":false,"description":"Represents a summary of price details for a credit memo."}],"description":"Pricing details of the credit memo."},"product":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"externalIds":{"allOf":[{"type":"object","properties":{"operations":{"type":"string","nullable":true}},"additionalProperties":false}]},"icon":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false}]},"seller":{"type":"object","allOf":[{"type":"object","properties":{"id":{"type":"string"},"icon":{"type":"string","nullable":true},"externalId":{"type":"string","nullable":true},"name":{"type":"string"},"erpLink":{"allOf":[{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"at":{"type":"string","format":"date-time","nullable":true},"by":{"allOf":[{"type":"object","properties":{"id":{"type":"string"},"audit":{"allOf":[{"type":"object","properties":{"created":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"updated":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"$meta":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/$meta/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"name":{"type":"string"},"icon":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true},"updated":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"blocked":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"unblocked":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties/erpLink/allOf/0/properties/audit/allOf/0/properties/created/allOf/0/properties"},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"$meta":{"allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/$meta/allOf/0/properties"},"additionalProperties":false}],"nullable":true},"icon":{"type":"string","nullable":true},"buyer":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/buyer/allOf/0/properties"},"additionalProperties":false}]},"seller":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/seller/allOf/0/properties"},"additionalProperties":false}]},"name":{"type":"string"},"status":{"allOf":[{"enum":["Active","Blocked"],"type":"string"}]},"note":{"type":"string","nullable":true},"externalIds":{"allOf":[{"type":"object","properties":{"erpCompanyContact":{"type":"string","nullable":true},"erpCustomer":{"type":"string","nullable":true},"accountExternalId":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true},"address":{"allOf":[{"type":"object","properties":{"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"postCode":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"country":{"type":"string","nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}],"nullable":true}},"additionalProperties":false}]},"status":{"allOf":[{"enum":["Issued"],"type":"string"}],"description":"The current status of the credit memo."},"vendor":{"type":"object","allOf":[{"type":"object","properties":{"$ref":"#/paths/~1public~1v1~1billing~1credit-memos~1{id}/get/responses/200/content/application~1json/schema/properties/client/allOf/0/properties"},"additionalProperties":false}]}},"additionalProperties":false,"description":"Represents a credit memo in the billing system."}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}}}}}}}}
```
