loans--invoices

Operations addressed under /loans — 79 operations.

Rendered section: This page contains the invoices route group from loans. This is a presentation-only partition; it does not change the API contract or operation tags in the downloadable OpenAPI.

get-loan-invoice-by-loan-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<LoanInvoiceDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`LoanId`	`Guid`	no
`InvoiceAmount`	`decimal?`	yes
`InvoiceDate`	`DateOnly?`	yes
`SerialNumber`	`string`	no
`UsingInvoiceAmount`	`decimal?`	yes
`ShipmentDate`	`DateOnly?`	yes
`InvoiceIssuer`	`string`	no
`IsOfficialInvoice`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

get-loan-invoice-by-loan-id › path Parameters

id

string · uuid · required

get-loan-invoice-by-loan-id › Responses

Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.

object[]

Array of catalog-declared response records.

id

string · uuid

invoiceAmount

number · decimal

invoiceDate

string · date-time

invoiceIssuer

string

isOfficialInvoice

boolean

loanId

string · uuid

serialNumber

string

shipmentDate

string · date-time

usingInvoiceAmount

number · decimal

create-loan-invoice

POST

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

create-loan-invoice › path Parameters

id

string · uuid · required

create-loan-invoice › Request Body

invoiceAmount

number · decimal · required

invoiceDate

string · date-time · required

invoiceIssuer

string · required

serialNumber

string · required

shipmentDate

string · date-time · required

usingInvoiceAmount

number · decimal · required

isOfficialInvoice

boolean

create-loan-invoice › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/loans/{id}/invoices

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/invoices \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceAmount": 0,
  "invoiceDate": "",
  "invoiceIssuer": "",
  "isOfficialInvoice": false,
  "serialNumber": "",
  "shipmentDate": "",
  "usingInvoiceAmount": 0
}'

Example Request Body

{
  "invoiceAmount": 0,
  "invoiceDate": "",
  "invoiceIssuer": "",
  "isOfficialInvoice": false,
  "serialNumber": "",
  "shipmentDate": "",
  "usingInvoiceAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-loan-invoice-by-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices/{invoiceId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as LoanInvoiceDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`LoanId`	`Guid`	no
`InvoiceAmount`	`decimal?`	yes
`InvoiceDate`	`DateOnly?`	yes
`SerialNumber`	`string`	no
`UsingInvoiceAmount`	`decimal?`	yes
`ShipmentDate`	`DateOnly?`	yes
`InvoiceIssuer`	`string`	no
`IsOfficialInvoice`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_107`	400	`LOAN_INVOICE_NOT_FOUND`	Loan Date Must Be Today For Cancel
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`	not published in this snapshot

get-loan-invoice-by-id › path Parameters

id

string · uuid · required

invoiceId

string · uuid · required

get-loan-invoice-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-loan-invoice

PUT

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices/{invoiceId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_107`	400	`LOAN_INVOICE_NOT_FOUND`	Loan Date Must Be Today For Cancel
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`	not published in this snapshot

update-loan-invoice › path Parameters

id

string · uuid · required

invoiceId

string · uuid · required

update-loan-invoice › Request Body

invoiceAmount

number · decimal · required

invoiceDate

string · date-time · required

invoiceIssuer

string · required

serialNumber

string · required

shipmentDate

string · date-time · required

usingInvoiceAmount

number · decimal · required

isOfficialInvoice

boolean

update-loan-invoice › Responses

Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.

No data returned

loans--internal-external-disbursement loans--metal-purchases

Loan Service

loans--invoices

Operations addressed under /loans — 79 operations.

get-loan-invoice-by-loan-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as IEnumerable<LoanInvoiceDto>.

Field	Declared type	Nullable
`Id`	`Guid`	no
`LoanId`	`Guid`	no
`InvoiceAmount`	`decimal?`	yes
`InvoiceDate`	`DateOnly?`	yes
`SerialNumber`	`string`	no
`UsingInvoiceAmount`	`decimal?`	yes
`ShipmentDate`	`DateOnly?`	yes
`InvoiceIssuer`	`string`	no
`IsOfficialInvoice`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

get-loan-invoice-by-loan-id › path Parameters

id

string · uuid · required

get-loan-invoice-by-loan-id › Responses

object[]

Array of catalog-declared response records.

id

string · uuid

invoiceAmount

number · decimal

invoiceDate

string · date-time

invoiceIssuer

string

isOfficialInvoice

boolean

loanId

string · uuid

serialNumber

string

shipmentDate

string · date-time

usingInvoiceAmount

number · decimal

create-loan-invoice

POST

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

Field	Name on the wire	Declared type	Nullable
`Id`	`id`	`Guid`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`

create-loan-invoice › path Parameters

id

string · uuid · required

create-loan-invoice › Request Body

invoiceAmount

number · decimal · required

invoiceDate

string · date-time · required

invoiceIssuer

string · required

serialNumber

string · required

shipmentDate

string · date-time · required

usingInvoiceAmount

number · decimal · required

isOfficialInvoice

boolean

create-loan-invoice › Responses

Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.

Body shape declared by the exact route registration for the catalog's 200 response.

id

string · uuid

Identifier returned by the command.

POST/loans/{id}/invoices

curl https://dg-sandbox.dgpays.com/loan-service/loans/:id/invoices \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "invoiceAmount": 0,
  "invoiceDate": "",
  "invoiceIssuer": "",
  "isOfficialInvoice": false,
  "serialNumber": "",
  "shipmentDate": "",
  "usingInvoiceAmount": 0
}'

Example Request Body

{
  "invoiceAmount": 0,
  "invoiceDate": "",
  "invoiceIssuer": "",
  "isOfficialInvoice": false,
  "serialNumber": "",
  "shipmentDate": "",
  "usingInvoiceAmount": 0
}

json

The field names and types this operation declares. Replace the values before sending.

application/json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000"
}

json

application/json

get-loan-invoice-by-id

GET

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices/{invoiceId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Response body, read from the service source

The route declares its response as LoanInvoiceDto.

Field	Declared type	Nullable
`Id`	`Guid`	no
`LoanId`	`Guid`	no
`InvoiceAmount`	`decimal?`	yes
`InvoiceDate`	`DateOnly?`	yes
`SerialNumber`	`string`	no
`UsingInvoiceAmount`	`decimal?`	yes
`ShipmentDate`	`DateOnly?`	yes
`InvoiceIssuer`	`string`	no
`IsOfficialInvoice`	`bool`	no

Member names are the service's declaration names.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_107`	400	`LOAN_INVOICE_NOT_FOUND`	Loan Date Must Be Today For Cancel
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`	not published in this snapshot

get-loan-invoice-by-id › path Parameters

id

string · uuid · required

invoiceId

string · uuid · required

get-loan-invoice-by-id › Responses

Success. An exact, uniquely bound route registration classifies this response as a single-record.

No data returned

update-loan-invoice

PUT

https://dg-sandbox.dgpays.com/loan-service

/loans/{id}/invoices/{invoiceId}

Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.

Error codes this operation is known to raise

Code	Status	Meaning	Message
`ERR_LOAN_107`	400	`LOAN_INVOICE_NOT_FOUND`	Loan Date Must Be Today For Cancel
`ERR_LOAN_17`	400	`LOAN_MUST_NOT_BE_NULL`	not published in this snapshot

update-loan-invoice › path Parameters

id

string · uuid · required

invoiceId

string · uuid · required

update-loan-invoice › Request Body

invoiceAmount

number · decimal · required

invoiceDate

string · date-time · required

invoiceIssuer

string · required

serialNumber

string · required

shipmentDate

string · date-time · required

usingInvoiceAmount

number · decimal · required

isOfficialInvoice

boolean

update-loan-invoice › Responses

No data returned

loans--internal-external-disbursement loans--metal-purchases