# Models

## The CategoryDetails object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"CategoryDetails":{"type":"object","properties":{"id":{"type":"integer","description":"The numeric id of this document category.","format":"int32"},"name":{"type":"string","description":"The name of this document category","nullable":true},"description":{"type":"string","description":"A description of this document category.","nullable":true}},"additionalProperties":false,"description":"The category that this document was classified under when uploaded.\r\nA list of the available document categories can be retrieved by calling the Get Document Types endpoint."}}}}
```

## The DocumentMetadata object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"DocumentMetadata":{"type":"object","properties":{"documentId":{"type":"string","description":"A GUID that identifies this specific document.","format":"uuid"},"merchantNumber":{"type":"string","description":"The Merchant Number that this document is associated with.","nullable":true},"name":{"type":"string","description":"The name of the document.","nullable":true},"description":{"type":"string","description":"An optional description of the document.","nullable":true},"category":{"$ref":"#/components/schemas/CategoryDetails"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string","description":"Additional properties"},"description":"An dictionary containing additional metadata about this document. Metadata will often include the Month and Year\r\nfor which a particular document was generated, however thse fields may be missing depending on the type of document \r\nand the age of the document being requested. Any code using this should handle the situation where those fields are\r\nnot present.","nullable":true,"readOnly":true},"documentURL":{"type":"string","description":"The URL that can be used to download the document.","nullable":true}},"additionalProperties":false},"CategoryDetails":{"type":"object","properties":{"id":{"type":"integer","description":"The numeric id of this document category.","format":"int32"},"name":{"type":"string","description":"The name of this document category","nullable":true},"description":{"type":"string","description":"A description of this document category.","nullable":true}},"additionalProperties":false,"description":"The category that this document was classified under when uploaded.\r\nA list of the available document categories can be retrieved by calling the Get Document Types endpoint."}}}}
```

## The DocumentResult object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"DocumentResult":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/DocumentMetadata"},"nullable":true}},"additionalProperties":false,"description":"An array containing the set of document categories available."},"DocumentMetadata":{"type":"object","properties":{"documentId":{"type":"string","description":"A GUID that identifies this specific document.","format":"uuid"},"merchantNumber":{"type":"string","description":"The Merchant Number that this document is associated with.","nullable":true},"name":{"type":"string","description":"The name of the document.","nullable":true},"description":{"type":"string","description":"An optional description of the document.","nullable":true},"category":{"$ref":"#/components/schemas/CategoryDetails"},"additionalProperties":{"type":"object","additionalProperties":{"type":"string","description":"Additional properties"},"description":"An dictionary containing additional metadata about this document. Metadata will often include the Month and Year\r\nfor which a particular document was generated, however thse fields may be missing depending on the type of document \r\nand the age of the document being requested. Any code using this should handle the situation where those fields are\r\nnot present.","nullable":true,"readOnly":true},"documentURL":{"type":"string","description":"The URL that can be used to download the document.","nullable":true}},"additionalProperties":false},"CategoryDetails":{"type":"object","properties":{"id":{"type":"integer","description":"The numeric id of this document category.","format":"int32"},"name":{"type":"string","description":"The name of this document category","nullable":true},"description":{"type":"string","description":"A description of this document category.","nullable":true}},"additionalProperties":false,"description":"The category that this document was classified under when uploaded.\r\nA list of the available document categories can be retrieved by calling the Get Document Types endpoint."}}}}
```

## The DocumentTypes object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"DocumentTypes":{"type":"object","properties":{"types":{"type":"array","items":{"$ref":"#/components/schemas/CategoryDetails"},"description":"An array containing the set of document categories available.","nullable":true}},"additionalProperties":false},"CategoryDetails":{"type":"object","properties":{"id":{"type":"integer","description":"The numeric id of this document category.","format":"int32"},"name":{"type":"string","description":"The name of this document category","nullable":true},"description":{"type":"string","description":"A description of this document category.","nullable":true}},"additionalProperties":false,"description":"The category that this document was classified under when uploaded.\r\nA list of the available document categories can be retrieved by calling the Get Document Types endpoint."}}}}
```

## The ErrorResults object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"ErrorResults":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ReportingError"},"nullable":true},"statusCode":{"type":"integer","format":"int32"}},"additionalProperties":false},"ReportingError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"A human readable description of the error that occurred. These descriptions are subject to change and may be\r\nupdated to better reflect different scenarios. ResultCode should be used instead if any programmatic handling\r\nof errors is needed.","nullable":true},"resultCode":{"type":"integer","description":"A numeric identifier for the error.","format":"int32"},"timeStamp":{"type":"string","description":"The time at which the error occurred expressed as Coordinated Universal Time (UTC).","format":"date-time","readOnly":true}},"additionalProperties":false}}}}
```

## The ReportingError object

```json
{"openapi":"3.0.1","info":{"title":"EDocs Reporting API - US Onboarding","version":"1.0"},"components":{"schemas":{"ReportingError":{"type":"object","properties":{"errorMessage":{"type":"string","description":"A human readable description of the error that occurred. These descriptions are subject to change and may be\r\nupdated to better reflect different scenarios. ResultCode should be used instead if any programmatic handling\r\nof errors is needed.","nullable":true},"resultCode":{"type":"integer","description":"A numeric identifier for the error.","format":"int32"},"timeStamp":{"type":"string","description":"The time at which the error occurred expressed as Coordinated Universal Time (UTC).","format":"date-time","readOnly":true}},"additionalProperties":false}}}}
```