In this article, you can read about how to retrieve invoices, credit notes, invoice PDFs, credit note PDFs, invoice attachments, and invoice orders via the API, as well as how to insert and delete invoice/credit note export logs.
Get Invoices
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=invoice&page=1Retrieving invoices is done through the GET method. Use this to download invoices from your Recman account.
Note
If an invoice has an attached object, it can be downloaded separately using the invoiceAttachment scope (see below).
| URL | https://api.recman.io/v2/get/ |
| Scope | invoice |
| Page | Page number, 1000 invoices per page |
| Parameters | invoiceId, invoiceIds, minInvoiceId, exported, invoiceSystemId |
PARAMS
| key | {{api_key}} |
| scope | invoice |
| page | 1 |
Get Credit Notes
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=creditNote&page=1Retrieving credit notes is done through the GET method. Use this to download credit notes from your Recman account.
| URL | https://api.recman.io/v2/get/ |
| Scope | creditNote |
| Page | Page number, 1000 credit notes per page |
| Parameters | creditNoteId, creditNoteIds, minCreditNoteId, exported, creditNoteSystemId |
PARAMS
| key | {{api_key}} |
| scope | creditNote |
| page | 1 |
Get Invoice PDF
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=invoicePdf&invoiceId=508098Retrieving an invoice PDF is done through the GET method.
Note
The parameters languageId and layoutId will be set automatically based on what is default on the customer and department, if not set manually.
| URL | https://api.recman.io/v2/get/ |
| Scope | invoicePdf |
| Operation | GET |
| Parameters | invoiceId, languageId, layoutId |
PARAMS
| key | {{api_key}} |
| scope | invoicePdf |
| invoiceId | 508098 |
Get Credit Note PDF
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=creditNotePdf&creditNoteId=48726Retrieving a credit note PDF is done through the GET method.
Note
The parameters languageId and layoutId will be set automatically based on what is default on the customer and department, if not set manually.
| URL | https://api.recman.io/v2/get/ |
| Scope | creditNotePdf |
| Operation | GET |
| Parameters | creditNoteId, languageId, layoutId |
PARAMS
| key | {{api_key}} |
| scope | creditNotePdf |
| creditNoteId | 48726 |
Get Invoice Attachment
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=invoiceAttachment&invoiceAttachmentId=145510Retrieving an invoice attachment is done through the GET method.
| URL | https://api.recman.io/v2/get/ |
| Scope | invoiceAttachment |
| Operation | GET |
| Parameters | invoiceAttachmentId |
PARAMS
| key | {{api_key}} |
| scope | invoiceAttachment |
| invoiceAttachmentId | 145510 |
| invoiceId | 907888 |
Get Invoice Orders
GET
https://api.recman.io/v2/get/?key={{api_key}}&
scope=invoiceOrderGet a list of invoice orders through the GET method.
PARAMS
| key | {{api_key}} |
| scope | invoiceOrder |
Insert / Delete Invoice Export Log
POST
https://api.recman.io/v2/post/The POST method is used for inserting and deleting invoice export logs.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | invoiceExportLog |
| Operation | insert / delete |
Fields
| Field | Description |
|---|---|
| invoiceId integer | Invoice ID. Required on operation: insert |
| userId integer | User ID. Required on operation: insert |
| invoiceSystemId integer | Invoice system ID. Required on operation: insert |
| invoiceExportLogId integer | Invoice export log ID. Required on operation: delete |
Request Body — Insert
| key | {{api_key}} |
| scope | invoiceExportLog |
| operation | insert |
| data.invoiceId | 423562 |
| data.userId | 13236 |
| data.invoiceSystemId | 755682 |
Request Body — Delete
| key | {{api_key}} |
| scope | invoiceExportLog |
| operation | delete |
| data.invoiceExportLogId | 321312 |
Insert / Delete Credit Note Export Log
POST
https://api.recman.io/v2/post/The POST method is used for inserting and deleting credit note export logs.
| URL POST | https://api.recman.io/v2/post/ |
| Scope | creditNoteExportLog |
| Operation | insert / delete |
Fields
| Field | Description |
|---|---|
| creditNoteId integer | Credit Note ID. Required on operation: insert |
| userId integer | User ID. Required on operation: insert |
| invoiceSystemId integer | Invoice system ID. Required on operation: insert |
| creditNoteExportLogId integer | Credit note export log ID. Required on operation: delete |
Request Body — Insert
| key | {{api_key}} |
| scope | creditNoteExportLog |
| operation | insert |
| data.creditNoteId | 423562 |
| data.userId | 13236 |
| data.invoiceSystemId | 755682 |
What's next
Continue with the Paycheck and Payroll articles, or the Salary Matrix and Cost Center articles, all part of the Economy series.