POST CustomerReceipt/Save?useSystemDocumentNumber={useSystemDocumentNumber}
Saves the specified Customer Receipt.
Request Information
URI Parameters
Name | Type | Additional information | Description |
---|---|---|---|
useSystemDocumentNumber | bool |
Default value is True |
Use system Document Number or Document Number provided. |
Body Parameters
The Customer Receipt.
Customer ReceiptName | Type | Additional information | Description |
---|---|---|---|
ID | integer |
None. |
|
CustomerId | integer |
None. |
|
Date | date |
None. |
|
Payee | string |
String length: inclusive between 0 and 8000 |
|
DocumentNumber | string |
String length: inclusive between 0 and 100 |
|
Reference | string |
String length: inclusive between 0 and 100 |
|
Description | string |
String length: inclusive between 0 and 100 |
|
Comments | string |
String length: inclusive between 0 and 8000 |
|
Total | decimal |
None. |
|
Discount | decimal |
None. |
|
TotalUnallocated | decimal |
None. |
|
Reconciled | bool |
None. |
|
BankAccountId | integer |
None. |
|
PaymentMethod | Payment Method |
None. |
|
Status | Customer Receipt Status |
None. |
|
TaxPeriodId | nullable integer |
Read Only / System Generated |
|
Editable | bool |
Read Only / System Generated |
|
Accepted | bool |
None. |
|
Locked | bool |
Read Only / System Generated |
|
AnalysisCategoryId1 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
AnalysisCategoryId2 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
AnalysisCategoryId3 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
Printed | bool |
Read Only / System Generated |
|
BankUniqueIdentifier | string |
None. |
|
ImportTypeId | nullable integer |
None. |
|
BankImportMappingId | nullable integer |
None. |
|
BankAccount_CurrencyId | nullable integer |
None. |
|
BankAccount_ExchangeRate | nullable decimal |
None. |
|
Customer_CurrencyId | nullable integer |
None. |
|
Customer_ExchangeRate | nullable decimal |
None. |
|
Modified | nullable date |
Read Only / System Generated |
|
Created | date |
Read Only / System Generated |
|
Customer | Customer |
Read Only / System Generated |
|
SalesRepresentative | Sales Representative |
Read Only / System Generated |
|
BankAccount | Bank Account |
Read Only / System Generated |
|
UID | globally unique identifier |
Read Only / System Generated |
Request Formats
application/json, text/json
{ "ID": 1, "CustomerId": 2, "Date": "2025-07-06", "Payee": "sample string 4", "DocumentNumber": "sample string 5", "Reference": "sample string 6", "Description": "sample string 7", "Comments": "sample string 8", "Total": 9.0, "Discount": 10.0, "TotalUnallocated": 11.0, "Reconciled": true, "BankAccountId": 13, "PaymentMethod": 1, "Status": 0, "TaxPeriodId": 1, "Editable": true, "Accepted": true, "Locked": true, "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "Printed": true, "BankUniqueIdentifier": "sample string 18", "ImportTypeId": 1, "BankImportMappingId": 1, "BankAccount_CurrencyId": 1, "BankAccount_ExchangeRate": 1.0, "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "Modified": "2025-07-06", "Created": "2025-07-06", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2025-07-06", "Created": "2025-07-06" }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2025-07-06", "Modified": "2025-07-06" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "CommunicationMethod": 1, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "EnableCustomerZone": true, "CustomerZoneGuid": "e7c1e20b-bddf-4f8f-bcee-7dcce6fdab5a", "CashSale": true, "TextField1": "sample string 25", "TextField2": "sample string 26", "TextField3": "sample string 27", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2025-07-06", "DateField2": "2025-07-06", "DateField3": "2025-07-06", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2025-07-06", "Created": "2025-07-06", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2025-07-06", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2025-07-06", "Modified": "2025-07-06", "TaxTypeDefaultUID": "5eb3c490-8542-43f7-9920-6f70e8faa18f", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2025-07-06", "Modified": "2025-07-06" }, "BankAccount": { "Name": "sample string 2", "BankName": "sample string 3", "AccountNumber": "sample string 4", "BranchName": "sample string 5", "BranchNumber": "sample string 6", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2025-07-06", "Created": "2025-07-06" }, "Active": true, "Default": true, "Balance": 9.0, "Description": "sample string 10", "BankFeedAccount": { "ID": 1, "BankFeedAccountGroupId": 2, "BankFeedAccountGroup": { "ID": 1, "BankFeedProviderId": 2, "BankFeedProviderTypeId": 3, "Description": "sample string 4", "Identifier": "sample string 5", "RequiresAdditionalAuthentication": true, "LastRefreshStatusId": 7 }, "Description": "sample string 3", "Identifier": "sample string 4", "LastRefreshDate": "2025-07-06", "FirstImportDate": "2025-07-06", "Balance": 1.0, "BankAccountId": 1, "BankAccountName": "sample string 5", "LastRefreshStatusId": 6 }, "LastTransactionDate": "2025-07-06", "LastImportDate": "2025-07-06", "HasTransactionsWaitingForReview": true, "HasActivity": true, "DefaultPaymentMethodId": 1, "PaymentMethod": 1, "Modified": "2025-07-06", "Created": "2025-07-06", "CurrencyId": 1, "ID": 13 }, "UID": "b5a71eb6-bb41-41ce-bdfb-9c34dbf227e0", "$TrackingCode": "sample string 20" }
Response Information
Resource Description
Customer ReceiptName | Type | Additional information | Description |
---|---|---|---|
ID | integer |
None. |
|
CustomerId | integer |
None. |
|
Date | date |
None. |
|
Payee | string |
String length: inclusive between 0 and 8000 |
|
DocumentNumber | string |
String length: inclusive between 0 and 100 |
|
Reference | string |
String length: inclusive between 0 and 100 |
|
Description | string |
String length: inclusive between 0 and 100 |
|
Comments | string |
String length: inclusive between 0 and 8000 |
|
Total | decimal |
None. |
|
Discount | decimal |
None. |
|
TotalUnallocated | decimal |
None. |
|
Reconciled | bool |
None. |
|
BankAccountId | integer |
None. |
|
PaymentMethod | Payment Method |
None. |
|
Status | Customer Receipt Status |
None. |
|
TaxPeriodId | nullable integer |
Read Only / System Generated |
|
Editable | bool |
Read Only / System Generated |
|
Accepted | bool |
None. |
|
Locked | bool |
Read Only / System Generated |
|
AnalysisCategoryId1 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
AnalysisCategoryId2 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
AnalysisCategoryId3 | nullable integer |
None. |
Gets or sets the Analysis Category identifier. This needs to be a valid AnalysisCategoryId. |
Printed | bool |
Read Only / System Generated |
|
BankUniqueIdentifier | string |
None. |
|
ImportTypeId | nullable integer |
None. |
|
BankImportMappingId | nullable integer |
None. |
|
BankAccount_CurrencyId | nullable integer |
None. |
|
BankAccount_ExchangeRate | nullable decimal |
None. |
|
Customer_CurrencyId | nullable integer |
None. |
|
Customer_ExchangeRate | nullable decimal |
None. |
|
Modified | nullable date |
Read Only / System Generated |
|
Created | date |
Read Only / System Generated |
|
Customer | Customer |
Read Only / System Generated |
|
SalesRepresentative | Sales Representative |
Read Only / System Generated |
|
BankAccount | Bank Account |
Read Only / System Generated |
|
UID | globally unique identifier |
Read Only / System Generated |
Response Formats
application/json, text/json
{ "ID": 1, "CustomerId": 2, "Date": "2025-07-06", "Payee": "sample string 4", "DocumentNumber": "sample string 5", "Reference": "sample string 6", "Description": "sample string 7", "Comments": "sample string 8", "Total": 9.0, "Discount": 10.0, "TotalUnallocated": 11.0, "Reconciled": true, "BankAccountId": 13, "PaymentMethod": 1, "Status": 0, "TaxPeriodId": 1, "Editable": true, "Accepted": true, "Locked": true, "AnalysisCategoryId1": 1, "AnalysisCategoryId2": 1, "AnalysisCategoryId3": 1, "Printed": true, "BankUniqueIdentifier": "sample string 18", "ImportTypeId": 1, "BankImportMappingId": 1, "BankAccount_CurrencyId": 1, "BankAccount_ExchangeRate": 1.0, "Customer_CurrencyId": 1, "Customer_ExchangeRate": 1.0, "Modified": "2025-07-06", "Created": "2025-07-06", "Customer": { "Name": "sample string 1", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2025-07-06", "Created": "2025-07-06" }, "SalesRepresentativeId": 1, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2025-07-06", "Modified": "2025-07-06" }, "TaxReference": "sample string 2", "ContactName": "sample string 3", "Telephone": "sample string 4", "Fax": "sample string 5", "Mobile": "sample string 6", "Email": "sample string 7", "WebAddress": "sample string 8", "Active": true, "IsObfuscated": true, "Balance": 11.0, "CreditLimit": 12.0, "CommunicationMethod": 1, "PostalAddress01": "sample string 13", "PostalAddress02": "sample string 14", "PostalAddress03": "sample string 15", "PostalAddress04": "sample string 16", "PostalAddress05": "sample string 17", "DeliveryAddress01": "sample string 18", "DeliveryAddress02": "sample string 19", "DeliveryAddress03": "sample string 20", "DeliveryAddress04": "sample string 21", "DeliveryAddress05": "sample string 22", "AutoAllocateToOldestInvoice": true, "EnableCustomerZone": true, "CustomerZoneGuid": "6f1885f7-aedc-4bb6-b83c-941a98e0105c", "CashSale": true, "TextField1": "sample string 25", "TextField2": "sample string 26", "TextField3": "sample string 27", "NumericField1": 1.0, "NumericField2": 1.0, "NumericField3": 1.0, "YesNoField1": true, "YesNoField2": true, "YesNoField3": true, "DateField1": "2025-07-06", "DateField2": "2025-07-06", "DateField3": "2025-07-06", "DefaultPriceListId": 1, "DefaultPriceList": { "ID": 1, "Description": "sample string 2", "IsDefault": true }, "DefaultPriceListName": "sample string 2", "AcceptsElectronicInvoices": true, "Modified": "2025-07-06", "Created": "2025-07-06", "BusinessRegistrationNumber": "sample string 34", "TaxStatusVerified": "2025-07-06", "CurrencyId": 1, "CurrencySymbol": "sample string 35", "HasActivity": true, "DefaultDiscountPercentage": 1.0, "DefaultTaxTypeId": 1, "DefaultTaxType": { "ID": 1, "Name": "sample string 2", "Percentage": 3.1, "IsDefault": true, "HasActivity": true, "IsManualTax": true, "Active": true, "Created": "2025-07-06", "Modified": "2025-07-06", "TaxTypeDefaultUID": "268d9f24-7209-4efe-9f23-184950c56be4", "CompanyId": 9 }, "DueDateMethodId": 1, "DueDateMethodValue": 1, "CityId": 1, "AccountingAgreement": true, "HasSpecialCountryTaxActivity": true, "OutstandingInvoices": true, "OverdueInvoices": true, "OnHold": true, "ExcludeFromDebtorsManager": true, "SubjectToDRCVat": true, "ID": 40 }, "SalesRepresentative": { "ID": 1, "FirstName": "sample string 2", "LastName": "sample string 3", "Name": "sample string 2 sample string 3", "Active": true, "Email": "sample string 6", "Mobile": "sample string 7", "Telephone": "sample string 8", "Created": "2025-07-06", "Modified": "2025-07-06" }, "BankAccount": { "Name": "sample string 2", "BankName": "sample string 3", "AccountNumber": "sample string 4", "BranchName": "sample string 5", "BranchNumber": "sample string 6", "Category": { "Description": "sample string 1", "ID": 2, "Modified": "2025-07-06", "Created": "2025-07-06" }, "Active": true, "Default": true, "Balance": 9.0, "Description": "sample string 10", "BankFeedAccount": { "ID": 1, "BankFeedAccountGroupId": 2, "BankFeedAccountGroup": { "ID": 1, "BankFeedProviderId": 2, "BankFeedProviderTypeId": 3, "Description": "sample string 4", "Identifier": "sample string 5", "RequiresAdditionalAuthentication": true, "LastRefreshStatusId": 7 }, "Description": "sample string 3", "Identifier": "sample string 4", "LastRefreshDate": "2025-07-06", "FirstImportDate": "2025-07-06", "Balance": 1.0, "BankAccountId": 1, "BankAccountName": "sample string 5", "LastRefreshStatusId": 6 }, "LastTransactionDate": "2025-07-06", "LastImportDate": "2025-07-06", "HasTransactionsWaitingForReview": true, "HasActivity": true, "DefaultPaymentMethodId": 1, "PaymentMethod": 1, "Modified": "2025-07-06", "Created": "2025-07-06", "CurrencyId": 1, "ID": 13 }, "UID": "fa0dcb77-a5da-43b8-9b2b-2ef5b26859af", "$TrackingCode": "sample string 20" }